[SDK-165]: Updated READMEs to have consistent descriptions of settings, added section on how to use the .env.example files

Author: echarrod

README.md

@@ -91,17 +91,15 @@ import "yoti_python_sdk"
 
 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).
 
-The following variables are then required for the SDK to work:
+The following variables are then required for the SDK to work, these are found under the different tabs of your Yoti application's settings page ([Yoti Dashboard](https://www.yoti.com/dashboard/)):
 
-* `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)
+* **`YOTI_APPLICATION_ID`** - This is used to configure the [Yoti Login Button](https://www.yoti.com/developers/documentation/#2-front-end-integration).
+* **`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, we recommend keeping your .pem file outside of your repository. 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.
+**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.
+One way to configure these environment variables is to use an .env file. There are `.env.example` files supplied in the [Django](/examples/yoti_example_django/yoti_example/.env.example) and [Flask](/examples/yoti_example_flask/.env.example) example projects, which you can rename to `.env` and enter your settings into this file.
 
 ### Example
 

plugins/django_yoti/README.md

@@ -50,9 +50,17 @@ def some_view(request):
     return render(request, 'index.html', yoti_context)
 ```
 
-* And then use the following settings to configure the plugin:
+The following variables are then required for the plugin to work, these are found under the different tabs of your Yoti application's settings page ([Yoti Dashboard](https://www.yoti.com/dashboard/)):
 
+* **`YOTI_APPLICATION_ID`** - This is used to configure the [Yoti Login Button](https://www.yoti.com/developers/documentation/#2-front-end-integration).
+* **`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, we recommend keeping your .pem file outside of your repository. 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.
+
+One way to configure these environment variables is to use an .env file. There are `.env.example` files supplied in the [Django](/examples/yoti_example_django/yoti_example/.env.example) and [Flask](/examples/yoti_example_flask/.env.example) example projects, which you can rename to `.env` and enter your settings into this file.
+
+Alternatively you could define these settings in the `settings.py` file like this:
 ```python
 # your_django_project/settings.py
 
@@ -65,21 +73,6 @@ YOTI = {
     ...
 }
 ```
-* **`YOTI_APPLICATION_ID`** - **required**, *can be also set by env variable with the same name*<br>
-Your Yoti application's ID, found under the `INTEGRATIONS` tab of your
-Yoti application's settings page ([Yoti Dashboard](https://www.yoti.com/dashboard/)).<br>
-It is used to configure the [Yoti Login Button](https://www.yoti.com/developers/#login-button-setup).<br>
-Example: `ca84f68b-1b48-458b-96bf-963868edc8b6`
-
-* **`YOTI_CLIENT_SDK_ID`** - **required**, *can be also set by env variable with the same name*<br>
-Your Yoti application's SDK ID, found under the `INTEGRATIONS` tab of your
-Yoti application's settings page ([Yoti Dashboard](https://www.yoti.com/dashboard/)).<br>
-Example: `39aef70a-89d6-4644-a687-b3e891613da6`
-
-* **`YOTI_KEY_FILE_PATH`** - **required**, *can be also set by env variable with the same name*<br>
-The full path to your private key downloaded from your Yoti application's
-settings page under the `KEYS` tab ([Yoti Dashboard](https://www.yoti.com/dashboard/)).<br>
-Example: `/home/user/.ssh/access-security.pem`
 
 ### Endpoints configuration ###
 

plugins/flask_yoti/README.md

@@ -17,8 +17,17 @@ app.register_blueprint(flask_yoti_blueprint, url_prefix='/yoti')
 ```
 *Don't forget to set an `app.secret_key` to be able to use `sessions`*
 
-* And then use the following settings to configure the plugin:
+The following variables are then required for the plugin to work, these are found under the different tabs of your Yoti application's settings page ([Yoti Dashboard](https://www.yoti.com/dashboard/)):
 
+* **`YOTI_APPLICATION_ID`** - This is used to configure the [Yoti Login Button](https://www.yoti.com/developers/documentation/#2-front-end-integration).
+* **`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, we recommend keeping your .pem file outside of your repository. 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.
+
+One way to configure these environment variables is to use an .env file. There are `.env.example` files supplied in the [Django](/examples/yoti_example_django/yoti_example/.env.example) and [Flask](/examples/yoti_example_flask/.env.example) example projects, which you can rename to `.env` and enter your settings into this file.
+
+Alternatively you could define these settings in the `app.py` file like this:
 
 ```python
 # your_flask_project/app.py
@@ -32,21 +41,6 @@ app.config.update({
     ...
 })
 ```
-* **`YOTI_APPLICATION_ID`** - **required**, *can be also set by env variable with the same name*<br>
-Your Yoti application's ID, found under the `INTEGRATIONS` tab of your
-Yoti application's settings page ([Yoti Dashboard](https://www.yoti.com/dashboard/)).<br>
-It is used to configure the [Yoti Login Button](https://www.yoti.com/developers/#login-button-setup).<br>
-Example: `ca84f68b-1b48-458b-96bf-963868edc8b6`
-
-* **`YOTI_CLIENT_SDK_ID`** - **required**, *can be also set by env variable with the same name*<br>
-Your Yoti application's SDK ID, found under the `INTEGRATIONS` tab of your
-Yoti application's settings page ([Yoti Dashboard](https://www.yoti.com/dashboard/)).<br>
-Example: `39aef70a-89d6-4644-a687-b3e891613da6`
-
-* **`YOTI_KEY_FILE_PATH`** - **required**, *can be also set by env variable with the same name*<br>
-The full path to your private key downloaded from your Yoti application's
-settings page under the `KEYS` tab ([Yoti Dashboard](https://www.yoti.com/dashboard/)).<br>
-Example: `/home/user/.ssh/access-security.pem`
 
 ### Endpoints configuration ###