Update Docs.

This commit is contained in:
Juan Ignacio Fiorentino 2015-03-25 14:54:11 -03:00
parent 724dcfdc1d
commit 363b654a58

12
DOC.md
View file

@ -2,8 +2,11 @@
Django OIDC Provider can help you providing out of the box all the endpoints, data and logic needed to add OpenID Connect capabilities to your Django projects.
**This project is still in DEVELOPMENT and is rapidly changing. DO NOT USE IT FOR PRODUCTION SITES, unless you know what you do.**
****************************************
Before getting started there are some important things that you should know:
* Although OpenID was built on top of OAuth2, this isn't an OAuth2 server. Maybe in a future it will be.
* Despite that implementation MUST support TLS. You can make request without using SSL. There is no control on that.
@ -26,6 +29,7 @@ Before getting started there are some important things that you should know:
- [Users And Clients](#users-and-clients)
- [Templates](#templates)
- [Server Endpoints](#server-endpoints)
- [Running Tests](#running-tests)
## Requirements
@ -261,3 +265,11 @@ POST /openid/userinfo/ HTTP/1.1
Host: localhost:8000
Authorization: Bearer [ACCESS_TOKEN]
```
## Running Tests
You need a Django project properly configured with the package. Then just run tests as normal.
```bash
$ python manage.py test oidc_provider
```