📝 Add example documentation

eduflow · Oct 28, 2018 · 3c99293 · 3c99293
1 parent f1101b4
commit 3c99293
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -9,6 +9,25 @@ Installation
 
    $ pip install --user flask-mongo-profiler
 
+Example
+-------
+
+.. code-block:: shell
+
+   # inside of a virtualenv
+   $ pip install flask-mongo-profiler
+
+   $ pip install -r requirements/contrib.txt
+   $ cd examples/flask_todo
+
+   # With debugger
+   $ env FLASK_ENV=develoment flask run
+
+   # Without
+   $ flask run
+
+   # Load pages, go to http://localhost:5000/admin/
+
 Project details
 ---------------