Skip to content

Commit c7be09a

Browse files
committed
[SDK-163: Added descriptions to plugin READMEs, tidying up
1 parent cd39590 commit c7be09a

File tree

3 files changed

+16
-14
lines changed

3 files changed

+16
-14
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ How to install the SDK to your project
2222
6) [Configuration](#configuration)-
2323
Entry point explanation
2424

25-
7) [Profile Retrieval](#profile-retrieval)-
26-
How to retrieve a Yoti profile using the token
25+
7) [Handling Users](#handling-users)-
26+
How to manage users
2727

2828
8) [Running the examples](#running-the-examples)-
2929
How to retrieve a Yoti profile using the token
@@ -37,12 +37,12 @@ Attributes defined
3737
11) [Running the tests](running-the-tests)-
3838
Running tests for SDK example
3939

40-
12) [Support](#support)-
41-
Please feel free to reach out
42-
43-
13) [Version Support](version-support) -
40+
12) [Version Support](version-support) -
4441
Extra information on ensuring correct version of Python is being used
4542

43+
13) [Support](#support)-
44+
Please feel free to reach out
45+
4646
## 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.
@@ -152,7 +152,7 @@ Both example applications utilise the env variables described in [Configuration]
152152

153153
### Plugins ###
154154

155-
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.
155+
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 the [Django](/plugins/django_yoti/README.md) and [Flask](/plugins/flask_yoti/README.mdl) README files for further details.
156156

157157
## Running the Tests
158158

plugins/django_yoti/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Django Yoti #
22

3-
Description
3+
Instructions for configuring your Django project to integrate with Yoti.
44

55
## Plugin configuration ##
66
### General settings ###
@@ -21,7 +21,7 @@ INSTALLED_APPS = [
2121
- `yoti_application_id`
2222
- `yoti_login_button_*`
2323

24-
* If you're using django template backend that supports context processors
24+
* If you're using a Django template backend that supports context processors
2525
like default DTL (Django Template Language) and want to use context tags
2626
inside your template (e.g. `{{ yoti_login_button_*}}`), then you should
2727
include `django_yoti`'s context processors into your templates
@@ -43,7 +43,7 @@ TEMPLATES = [
4343
},
4444
]
4545
```
46-
* Otherwise you'll have to pass yoti context to your templates manually:
46+
* Otherwise you'll have to pass Yoti context to your templates manually:
4747
```python
4848
from django_yoti import yoti_context
4949

@@ -94,7 +94,7 @@ urlpatterns = [
9494
url(r'^profile/', views.profile, name='yoti_profile')
9595
]
9696
```
97-
`yoti_auth` url is used for receiving token via callback and should'nt be changed.<br>
97+
`yoti_auth` URL is used for receiving token via callback and shouldn't be changed.<br>
9898
The last two URLs are examples and can be overridden by the following settings:
9999

100100
```python
@@ -188,9 +188,9 @@ def profile_view(request):
188188
```
189189
<br>
190190

191-
To make `yoti_authenticated` decorator work with django class based
191+
To make `yoti_authenticated` decorator work with Django class based
192192
views as well as with classic method based views, you can use it while
193-
declaring your project's urls:
193+
declaring your project's URLs:
194194
```python
195195
# your_django_project/urls.py
196196
from django_yoti import yoti_authenticated

plugins/flask_yoti/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Flask Yoti #
22

3+
Instructions for configuring your Flask project to integrate with Yoti.
4+
35
## Plugin configuration ##
46
### General settings ###
57

@@ -120,7 +122,7 @@ button in order for it to work. See: [Yoti Developers Documentation](https://www
120122

121123
2. After successful authentication, user will be redirected to a view,
122124
provided by the `YOTI_REDIRECT_TO` setting.
123-
3. In order to have an access to an authenticated user's information inside a view,
125+
3. In order to get access to an authenticated user's information inside a view,
124126
you should use a `@yoti_authenticated` decorator.
125127
Example:
126128
```python

0 commit comments

Comments
 (0)