updated documentation

README.md

@@ -1,28 +1,24 @@
 # Flask Monitoring Dashboard
-Dashboard for automatic monitoring of Flask web services.
+Dashboard for automatic monitoring of Flask web-services.
 
-The Flask Monitoring Dashboard provides 4 main functionalities:
+The Flask Monitoring Dashboard is an extension that offers 4 main functionalities with little effort from the Flask developer:
 - **Monitor the Flask application:**
-This Flask extensions finds all your endpoints.
-You can choose which endpoints you want to monitor and which not.
-Monitoring and endpoint allows you to see which endpoints are being processed quickly, and which are not.
-Additionally, it provides information about the performance of the endpoint throughout different versions and different users.
+Our Dashboard allows you to see which endpoints process a lot of request and how fast. 
+Additionally, it provides information about the evolving performance of an endpoint throughout different versions if you’re using git.
 - **Monitor your test coverage:**
-Find out what endpoints are covered by unittest. 
+The dashboard allows you to find out which endpoints are covered by unit tests, allowing also for integration with Travis for automation purposes. 
 For more information, see [this file](http://flask-monitoringdashboard.readthedocs.io/en/latest/functionality.html#test-coverage-monitoring).
 - **Collect extra information about outliers:**
-Outliers are requests that take way longer to process than regular requests.
-The dashboard stores more information about outliers, such as:
-    - The stacktrace in which it got stuck.
-    - Request values.
-    - Request headers.
-    - Request environment.
+Outliers are requests that take much longer to process than regular requests. 
+The dashboard automatically detects that a request is an outlier and stores extra information about it (stack trace, request values, Request headers, Request environment).
 - **Visualize the collected data in a number useful graphs:**
 The dashboard is automatically added to your existing Flask application.
-When running your app, the dashboard van be viewed by default in the route:
+You can view the results by default using the default endpoint (this can be configured to another route):
 
     [/dashboard](http://localhost:5000/dashboard)
 
+For a more advanced documentation, take a look at the information on [this site](http://flask-monitoringdashboard.readthedocs.io/en/latest/functionality.html).
+
 ### Status
 [![Build Status](https://travis-ci.org/flask-dashboard/Flask-MonitoringDashboard.svg?branch=master)](https://travis-ci.org/flask-dashboard/Flask-MonitoringDashboard.svg?branch=master)
 [![Documentation Status](https://readthedocs.org/projects/flask-monitoringdashboard/badge/?version=latest)](http://flask-monitoringdashboard.readthedocs.io/en/latest/?badge=latest)

docs/conf.py

@@ -86,7 +86,7 @@
 # documentation.
 #
 html_theme_options = {
-    'github_fork': 'https://github.com/flask-dashboard/Flask-MonitoringDashboard'
+    'github_fork': 'flask-dashboard/Flask-MonitoringDashboard'
 }
 
 html_sidebars = {'**': ['globaltoc.html', 'searchbox.html', 'sourcelink.html']}

docs/index.rst

@@ -16,34 +16,25 @@ Or you can watch the video below:
 
 Functionality
 -------------
-The Flask Monitoring Dashboard provides 4 main functionalities:
+The Flask Monitoring Dashboard is an extension that offers 4 main functionalities with little effort from the Flask developer:
 
 - **Monitor the Flask application:**
-  This Flask extensions finds all your endpoints.
-  You can choose which endpoints you want to monitor and which not.
-  Monitoring and endpoint allows you to see which endpoints are being processed quickly, and which are not.
-  Additionally, it provides information about the performance of the endpoint throughout different versions and different users.
+  Our Dashboard allows you to see which endpoints process a lot of request and how fast. 
+  Additionally, it provides information about the evolving performance of an endpoint throughout different versions if you’re using git.
 
 - **Monitor your test coverage:**
-  Find out what endpoints are covered by unittest.
-  For more information, `see this file <http://flask-monitoringdashboard.readthedocs.io/en/latest/functionality.html#test-coverage-monitoring>`_.
+  The dashboard allows you to find out which endpoints are covered by unit tests, allowing also for integration with Travis for automation purposes. 
+  For more information, see `this file <http://flask-monitoringdashboard.readthedocs.io/en/latest/functionality.html#test-coverage-monitoring>`_.
 
 - **Collect extra information about outliers:**
-  Outliers are requests that take way longer to process than regular requests.
-  The dashboard stores more information about outliers, such as:
-
-    - The stacktrace in which it got stuck.
-    - Request values.
-    - Request headers.
-    - Request environment.
-
+  Outliers are requests that take much longer to process than regular requests. 
+  The dashboard automatically detects that a request is an outlier and stores extra information about it (stack trace, request values, Request headers, Request environment).
 
 - **Visualize the collected data in a number useful graphs:**
   The dashboard is automatically added to your existing Flask application.
-  When running your app, the dashboard van be viewed by default in the route:
-  `/dashboard <localhost:5000/dashboard>`_
+  You can view the results by default using the default endpoint (this can be configured to another route): `dashboard <http://localhost:5000/dashboard>`_.
 
-For an detailed overview of the functionality in the dashboard, you `have a look at this page <functionality.html>`_.
+For a more advanced documentation, take a look at the information on `this page <http://flask-monitoringdashboard.readthedocs.io/en/latest/functionality.html>`_.
 
 User's Guide
 ------------

docs/installation.rst

@@ -32,6 +32,12 @@ This can be done by the following command:
 
    virtualenv ENV
 
+Or using the following command for Python3:
+
+.. code-block:: bash
+
+   virtualenv --python=python3 ENV
+
 Activate the Virtual Environment (Optional)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 This is the last part of the configuring the virtual environment.
@@ -44,7 +50,7 @@ It is (again) one simple command:
 
 Installing the Flask Monitoring Dashboard Package
 -------------------------------------------------
-Using the command below, you can install the Flask Monitoring Dashboard:
+You can install the Flask Monitoring Dashboard using the command below:
 
 .. code-block:: bash
 
@@ -61,7 +67,7 @@ Alternatively, you can install the Flask Monitoring Dashboard from
 
 Setup the Flask Monitoring Dashboard
 -------------------------------------
-Once you've successfully installed the package, you can use it in your code.
+After you've successfully installed the package, you can use it in your code.
 Suppose that you've already a Flask application that looks like this:
 
 .. code-block:: python
@@ -79,7 +85,7 @@ Suppose that you've already a Flask application that looks like this:
    if __name__ == '__main__':
      app.run(debug=True)
 
-With only two lines of code, you can add the extension to your Flask application:
+You can add the extension to your Flask application with only two lines of code:
 
 .. code-block:: python
 
@@ -108,5 +114,6 @@ Together, it becomes:
 
 Further configuration
 ---------------------
-You are now ready for using the Flask Monitoring Dashboard.
-For a more advanced used, which we recommend, have a look at `the configuration page <configuration.html>`_.
+You are now ready for using the Flask Monitoring Dashboard, and you can already view the dashboard at: `dashboard <http://localhost:5000/dashboard>`_.
+
+However, the Dashboard offers many functionality which have to be configured. This is explained on `the configuration page <configuration.html>`_.