Improve Readme

Author: Vasile Zaremba

README.md

@@ -47,7 +47,6 @@ Yoti SDK carries out for you steps 6, 7 and the profile decryption in step 8.
 
 ![alt text](login_flow.png "Login flow")
 
-
 Yoti also allows you to enable user details verification from your mobile app by means of the Android (TBA) and iOS (TBA) SDKs. In that scenario, your Yoti-enabled mobile app is playing both the role of the browser and the Yoti app. Your back-end doesn't need to handle these cases in a significantly different way. You might just decide to handle the `User-Agent` header in order to provide different responses for desktop and mobile clients.
 
 ## References
@@ -64,75 +63,90 @@ Yoti also allows you to enable user details verification from your mobile app by
 
 ## Requirements
 
-This SDK works with Python 2.6+ and Python 3.3+ .
+This SDK works with Python 2.6+ and Python 3.3+.
 
 ## Installing the SDK
 
 To import the Yoti SDK inside your project, simply run the following command from your terminal:
 
+```shell
+$ pip install yoti-python-sdk
 ```
-   $ pip install yoti-python-sdk
-```
-
-Both example applications utilise the env variables described above, make sure they are accessible.
-* Installing dependencies: `pip install -e .[examples]`
-
-Flask:
-
-* Run `python examples/yoti_example_flask/app.py`
-
-Djano:
-
-1. Apply migrations before the first start by running:<br>
-    `python examples/yoti_example_django/manage.py migrate`
-1. Run: `python examples/yoti_example_django/manage.py runserver 0.0.0.0:5000`
 
 ## SDK Project import
 
 You can reference the project URL by adding the following import:
 
-```
+```python
 import "yoti_python_sdk"
 ```
 
-Run your project but please make sure you have all the correct requirements:
+## Configuration
 
-1. Install dependencies: `pip install -r requirements.txt`
-2. Install the SDK: `python setup.py develop`
-3. Execute in the main project dir: `py.test`
-4. To execute integration tests run: `py.test -c pytest_integration.ini`
+After creating your application on the [Yoti Dashboard](https://www.yoti.com/dashboard/), you need to download the `.PEM` key and save it *outside* the repo (keep it private).
 
-## Configuration
+The following variables are then required for the SDK to work:
 
-The YotiClient is the SDK entry point. To initialise it you need include the following snippet inside your endpoint initialisation section:
+* `YOTI_CLIENT_SDK_ID` - is the SDK identifier generated by Yoti Dashboard in the Key tab when you create your app. Note this is not your Application Identifier which is needed by your client-side code
+* `YOTI_KEY_FILE_PATH` - is the path to the application pem file. It can be downloaded only once from the Keys tab in your Yoti Dashboard. (e.g. /home/user/.ssh/access-security.pem)
 
-```
+Please do not open the pem file as this might corrupt the key and you will need to create a new application.
+
+The following env variables are additionally used to configure your backend:
+* `YOTI_APPLICATION_ID` - found on the Integrations settings page, used to configure the [Yoti Login Button](https://www.yoti.com/developers/#login-button-setup).
+
+Keeping your settings and access keys outside your repository is highly recommended.
+
+### Example
+
+```python
 from yoti_python_sdk import Client
 @app.route('/profile')
 def auth():
     client = Client(YOTI_CLIENT_SDK_ID, YOTI_KEY_FILE_PATH)
     activity_details = client.get_activity_details(request.args['token'])
 ```
-Where:
-- `SDK_ID` is the SDK identifier generated by Yoti Dashboard in the Key tab when you create your app. Note this is not your Application Identifier which is needed by your client-side code.
-
-- `YOTI_KEY_FILE_PATH` is the path to the application pem file. It can be downloaded only once from the Keys tab in your Yoti Dashboard.
-
-Please do not open the pem file as this might corrupt the key and you will need to create a new application.
-
-Keeping your settings and access keys outside your repository is highly recommended. 
 
 ## Profile Retrieval
 
 When your application receives a token via the exposed endpoint (it will be assigned to a query string parameter named `token`), you can easily retrieve the user profile by adding the following to your endpoint handler:
 
-```
+```python
 activity_details = client.get_activity_details(request.args['token'])
 user_profile = activity_details.user_profile
     return render_template('profile.html',
                            **user_profile)
- ```                          
-     
+
+```
+
+## Running the examples
+
+Both example applications utilise the env variables described above, make sure they are accessible.
+
+* Installing dependencies: `pip install -e .[examples]`
+
+### Flask:
+
+* Run `python examples/yoti_example_flask/app.py`
+
+### Django:
+
+1. Apply migrations before the first start by running: `python examples/yoti_example_django/manage.py migrate`
+1. Run: `python examples/yoti_example_django/manage.py runserver 0.0.0.0:5000`
+
+### Plugins ###
+
+Plugins for both Django and Flask are in the `plugins/` dir. Their purpose is to make it as easy as possible to use the Yoti SDK with those frameworks. See their respective `README` files for details.
+
+## Running the tests
+
+Run your project but please make sure you have all the correct requirements:
+
+1. Install dependencies: `pip install -r requirements.txt`
+2. Install the SDK: `python setup.py develop`
+3. Execute in the main project dir: `py.test`
+4. To execute integration tests run: `py.test -c pytest_integration.ini`
+
 ## API Coverage
 
 * Activity Details
@@ -147,16 +161,8 @@ user_profile = activity_details.user_profile
         * [X] Address `postal_address`
         * [X] Gender `gender`
         * [X] Nationality `nationality`
+        * [X]
 
-## Support
-
-For any questions or support please email [[email protected]](mailto:[email protected]).
-Please provide the following the get you up and working as quick as possible:
-
-- Computer Type
-- OS Version
-- Version of Python being used
-- Screenshot
 
 ## Version Support
 ### Testing on multiple Python versions ###
@@ -177,23 +183,27 @@ test suite on Python 2.6 (2.6.9 in our case, as installed with `pyenv`).
 
 To install all the Python versions this SDK has been tested against run:
 
-    $ for version in 2.6.9 2.7.12 3.3.6 3.4.5 3.5.2 3.6.0b3; do pyenv install $version; done
+```shell
+$ for version in 2.6.9 2.7.12 3.3.6 3.4.5 3.5.2 3.6.0b3; do pyenv install $version; done
+```
 
-activate the installed interpreters (execute in this directory):
+Sctivate the installed interpreters (execute in this directory):
 
-    $ pyenv local 2.6.9 2.7.12 3.3.6 3.4.5 3.5.2 3.6.0b3
+```shell
+$ pyenv local 2.6.9 2.7.12 3.3.6 3.4.5 3.5.2 3.6.0b3
+```
 
-run the tests:
+Run the tests:
 
-    $ tox
+```shell
+$ tox
+```
 
 #### Tox Common Issues ####
 
 Supporting multiple Python versions with dependencies, often requiring compilation, is not without issues.
 
-For Python versions that do not provide binary wheels for `cryptography`, it
-will have to be compiled. This will be done automatically, however you may
-need to install development headers of `openssl`.
+For Python versions that do not provide binary wheels for `cryptography`, it will have to be compiled. This will be done automatically, however, you may need to install development headers of `openssl`.
 
 ##### On Debian-based systems #####
 
@@ -203,15 +213,29 @@ Install `openssl` headers with `apt-get install openssl-dev`
 
 Install `openssl` headers using [homebrew](http://brew.sh/): `brew install openssl`
 
-Install xcode command line tools so we have access to a C compiler and common libs:
+Install Xcode command line tools so we have access to a C compiler and common libs:
 
-    xcode-select --install
+```shell
+$ xcode-select --install
+```
 
 See [building cryptography on OS X](https://cryptography.io/en/latest/installation/#building-cryptography-on-os-x)
 
 
 For Python 2.6 and 2.7 you *might* have to install them via `pyenv` with specific unicode code point settings:
 
-    PYTHON_CONFIGURE_OPTS="--enable-unicode=ucs2" pyenv install <python version>
+```
+PYTHON_CONFIGURE_OPTS="--enable-unicode=ucs2" pyenv install <python version>
+```
+
+To avoid `cffi` errors related to unicode see: [cffi ucs2 vs ucs4](http://cffi.readthedocs.io/en/latest/installation.html#linux-and-os-x-ucs2-versus-ucs4)
 
-to avoid `cffi` errors related to unicode see: [cffi ucs2 vs ucs4](http://cffi.readthedocs.io/en/latest/installation.html#linux-and-os-x-ucs2-versus-ucs4)
+## Support
+
+For any questions or support please email [[email protected]](mailto:[email protected]).
+Please provide the following the get you up and working as quick as possible:
+
+- Computer Type
+- OS Version
+- Version of Python being used
+- Screenshot