Skip to content

Commit 6355b8b

Browse files
committed
[SDK-163]: Tidied up README
1 parent 05d42bc commit 6355b8b

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Please feel free to reach out
4343
13) [Version Support](version-support) -
4444
Extra information on ensuring correct version of Python is being used
4545

46-
## An Architectural view
46+
## An Architectural View
4747

4848
Before you start your integration, here is a bit of background on how the integration works. To integrate your application with Yoti, your back-end must expose a GET endpoint that Yoti will use to forward tokens.
4949
The endpoint can be configured in the Yoti Dashboard when you create/update your application. For more information on how to create an application please check our [developer page](https://www.yoti.com/developers/documentation/#login-button-setup).
@@ -79,7 +79,7 @@ To import the Yoti SDK inside your project, simply run the following command fro
7979
$ pip install yoti
8080
```
8181

82-
## SDK Project import
82+
## SDK Project Import
8383

8484
You can reference the project URL by adding the following import:
8585

@@ -122,7 +122,7 @@ Here is an example of how this works:
122122

123123
```python
124124
client = Client(YOTI_CLIENT_SDK_ID, YOTI_KEY_FILE_PATH)
125-
activity_details = client.get_activity_details(request.args['token'])
125+
activity_details = client.get_activity_details(token)
126126

127127
user_id = activity_details.user_profile.get('user_id')
128128
selfie = activity_details.user_profile.get('selfie')
@@ -135,9 +135,9 @@ gender = activity_details.user_profile.get('gender')
135135
nationality = activity_details.user_profile.get('nationality')
136136
```
137137

138-
## Running the examples
138+
## Running the Examples
139139

140-
Both example applications utilise the env variables described above, make sure they are accessible.
140+
Both example applications utilise the env variables described in [Configuration](#configuration), make sure they are accessible.
141141

142142
* Installing dependencies: `pip install -e .[examples]`
143143

@@ -154,7 +154,7 @@ Both example applications utilise the env variables described above, make sure t
154154

155155
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.
156156

157-
## Running the tests
157+
## Running the Tests
158158

159159
Run your project but please make sure you have all the correct requirements:
160160

@@ -218,7 +218,7 @@ Supporting multiple Python versions with dependencies, often requiring compilati
218218

219219
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`.
220220

221-
##### On Debian-based systems #####
221+
##### On Debian-based Systems #####
222222

223223
Install `openssl` headers with `apt-get install openssl-dev`
224224

0 commit comments

Comments
 (0)