From bcfb05fbcf00800eba2165adb8d83e2917299c26 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Diego=20In=C3=A1cio?= <diegodci@gmail.com>
Date: Wed, 12 Feb 2020 15:37:10 -0300
Subject: [PATCH] Update README

Basic description
---
 README.md | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)

diff --git a/README.md b/README.md
index e69de29..2a9779a 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,36 @@
+# Real-time object detection application
+
+Web application for *real-time* object detection on video streaming via web browser. 
+
+
+## Installation
+
+Create and activate an virtual environment, as follows:
+
+```bash
+$ cd cloned/directory/
+$ python -m venv env
+$ env/Scripts/activate
+```
+
+After have installed and activated the environment, install all the dependencies:
+
+```bash
+$ pip install -r requirements.txt
+```
+
+After that, you can run the *following command* and access the application at [127.0.0.1:5000](http://127.0.0.1:5000/) on your browser.
+
+```bash
+$ python application.py
+```
+
+*obs.: This application was tested only on *Google Chrome*.*
+
+## Usage
+
+- **Camera preview**: Enables and disables the webcam preview.
+- **Run detection model**: Enables and disables the detection model.
+- **Exposure**: Buttons which increase or decrease camera exposure stops by 1.
+- **Contrast**: Buttons which increase or decrease camera contrast stops by 4.
+- **Reset camera**: Reset all camera settings based on *camera_settings.log* file.
\ No newline at end of file