diff --git a/DOC.md b/DOC.md index e613e90..6a3cb31 100644 --- a/DOC.md +++ b/DOC.md @@ -38,7 +38,7 @@ Before getting started there are some important things that you should know: ## Installation -If you want to get started fast see our [Example App](https://github.com/juanifioren/django-oidc-provider/tree/master/example_app) folder. +If you want to get started fast see our [Example Project](https://github.com/juanifioren/django-oidc-provider/tree/master/example_project) folder. Install the package using pip. diff --git a/example_project/README.md b/example_project/README.md index 34dc26d..de5c475 100644 --- a/example_project/README.md +++ b/example_project/README.md @@ -1,6 +1,6 @@ -# Example Django App +# Example Project -This is just a simple Django app with all the necessary things to work with `django-oidc-provider` package. +Run your own OIDC provider in a second. This is a Django app with all the necessary things to work with `django-oidc-provider` package. ## Setup & Running @@ -9,6 +9,7 @@ Setup project environment with [virtualenv](https://virtualenv.pypa.io) and [pip ```bash $ virtualenv project_env $ source project_env/bin/activate + $ git clone https://github.com/juanifioren/django-oidc-provider.git $ cd django-oidc-provider/example_app $ pip install -r requirements.txt @@ -17,7 +18,6 @@ $ pip install -r requirements.txt Run your provider. ```bash -$ python manage.py makemigrations $ python manage.py migrate $ python manage.py runserver -``` \ No newline at end of file +```