Skip to content

Commit 5f9b400

Browse files
authored
Merge pull request #25 from browniebroke/patch-1
Typography and grammar fixes in README
2 parents b2e8be4 + 8b9801c commit 5f9b400

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ This library allow *Single Sign On* (SSO) integration into Django through the [O
2020

2121
It can be used to setup a Single Sign On using an identity provider (Keycloak, etc.) or to login using Google, Twitter, etc.
2222

23-
**Warning** : this library has not been audited. However, we are based on [pyoidc](https://github.com/CZ-NIC/pyoidc/) which we believe is a sane OIDC implementation.
23+
**Warning**: this library has not been audited. However, we are based on [pyoidc](https://github.com/CZ-NIC/pyoidc/) which we believe is a sane OIDC implementation.
2424

2525
We tried to make OpenID Connect (OIDC) configuration as easy and secure as possible. However
2626
everything can be customized, and we tried to take into account every use case in the library design.
@@ -47,10 +47,10 @@ If you are not satisfied with the default configuration, take a look at the cook
4747

4848
This library is built on the work of many others. First all, thanks to all the maintainers of [pyoidc](https://github.com/CZ-NIC/pyoidc/) as they did all the spec implementation. This library is mostly about glue between Django and *pyoidc*.
4949

50-
We were also heavily inspired by :
50+
We were also heavily inspired by:
5151

52-
* [`mozilla-django-oidc`](https://github.com/mozilla/mozilla-django-oidc) for it's login redirection URI management
53-
* [`django-auth-oidc`](https://gitlab.com/aiakos/django-auth-oidc) for it's hook system
52+
* [`mozilla-django-oidc`](https://github.com/mozilla/mozilla-django-oidc) for its login redirection URI management
53+
* [`django-auth-oidc`](https://gitlab.com/aiakos/django-auth-oidc) for its hook system
5454

5555
If you want to understand why we decided to implement our own library, this is documented [here](https://django-pyoidc.readthedocs.io/latest/explanation.html).
5656

@@ -60,13 +60,13 @@ The documentation is graciously hosted at [readthedocs](https://django-pyoidc.re
6060

6161
## Installation
6262

63-
First, install the python package :
63+
First, install the python package:
6464

6565
```bash
6666
pip install django_pyoidc
6767
```
6868

69-
Then add the library app to your django applications, after `django.contrib.sessions` and `django.contrib.auth` :
69+
Then add the library app to your django applications, after `django.contrib.sessions` and `django.contrib.auth`:
7070

7171
```python
7272
INSTALLED_APPS = [
@@ -77,21 +77,21 @@ INSTALLED_APPS = [
7777
]
7878
```
7979

80-
Don't forget to add the session middleware ! Add in your `settings.py` :
80+
Don't forget to add the session middleware! Add in your `settings.py`:
8181

8282
```python
8383
MIDDLEWARE = [
8484
"django.contrib.sessions.middleware.SessionMiddleware",
8585
]
8686
```
8787

88-
Now is time to run a migrate operation, as we create a database table ([read why here](https://django-pyoidc.readthedocs.io/latest/explanation.html#about-caching)). Run in your project dir :
88+
Now is time to run a migrate operation, as we create a database table ([read why here](https://django-pyoidc.readthedocs.io/latest/explanation.html#about-caching)). Run in your project dir:
8989

9090
```
9191
./manage.py migrate
9292
```
9393

94-
We also need a cache ([read why here](https://django-pyoidc.readthedocs.io/latest/explanation.html#about-caching)), so let's configure a dumb one for development purposes. Add in your `settings.py` :
94+
We also need a cache ([read why here](https://django-pyoidc.readthedocs.io/latest/explanation.html#about-caching)), so let's configure a dumb one for development purposes. Add in your `settings.py`:
9595

9696
```python
9797
CACHES = {
@@ -104,7 +104,7 @@ CACHES = {
104104

105105
Now you can pick an identity provider from the [available providers](https://django-pyoidc.readthedocs.io/latest/reference.html#providers). Providers class are a quick way to generate the library configuration and URLs. You can also configure the settings manually, but this is not recommended if you are not familiar with the OpendID Connect (OIDC) protocol.
106106

107-
Add the following `DJANGO_PYOIDC` to your `settings.py` :
107+
Add the following `DJANGO_PYOIDC` to your `settings.py`:
108108

109109
```python
110110
# settings
@@ -142,7 +142,7 @@ urlpatterns = [
142142
]
143143
```
144144

145-
And you are ready to go !
145+
And you are ready to go!
146146

147147
If you struggle with those instructions, take a look at [the quickstart tutorial](https://django-pyoidc.readthedocs.io/latest/tutorial.html).
148148

0 commit comments

Comments
 (0)