Updated documentation

Author: mkalioby

README.md

@@ -29,7 +29,7 @@ On May 3, 2023, Google allowed the use of Passkeys for the users to login, killi
 django-passkeys supports the following features:
 ### 1. Conditional UI
 **Conditional UI** is a way for the browser to prompt the user to use the passkey to login as shown.
-![conditionalUI.png](imgs%2FconditionalUI.png)
+![conditionalUI.png](docs/imgs%2FconditionalUI.png)
 
 ### 2. WebAuthn immediate mediation for frictionless sign-in
 
@@ -38,7 +38,7 @@ user to use password/passkeys without the need of a login form. This is currentl
 
 You can watch demo presented by Google
 
-[![Watch the video](imgs/immediate.png)](https://developer.chrome.com//static/blog/webauthn-immediate-mediation-ot/video/immediate-mediation-explicit-flow.mp4)
+[![Watch the video](docs/imgs/immediate.png)](https://developer.chrome.com//static/blog/webauthn-immediate-mediation-ot/video/immediate-mediation-explicit-flow.mp4)
 
 # Quick Start - Common Settings
 
@@ -108,7 +108,7 @@ Both can coexist in the same project — you can use templates for your web app
 
 ## Example Project
 
-See the `example` app and [Example.md](Example.md) for a working demo.
+See the `example` app and [Example.md](docs.Example.md) for a working demo for templates, drf and immediate mediation.
 
 ## Security contact information
 

build_docs.sh

@@ -0,0 +1 @@
+python -m mkdocs build --clean --site-dir ./html --config-file mkdocs.yml

docs/Example.md

@@ -0,0 +1,47 @@
+# Use of Example project
+
+1. Create virtual env
+   ```shell
+   python -m venv env
+   ```
+2. Activate env
+   ```
+   source env/bin/activate
+   ```
+3. Install requirements
+   ```
+   pip install -r requirements.txt
+   ```
+4. cd to example project
+   ```
+   cd example
+   ```
+5. Run migrations
+   ```
+   python manage.py migrate
+   ```
+6. Create superuser
+   ```
+   python manage.py createsuperuser
+   ```
+7. Start the server
+   ```
+   python manage.py runserver
+   ```
+8. Open `http://localhost:8000/` in your browser
+
+   **Important**: Use `localhost` not `127.0.0.1` — WebAuthn requires the domain to match `FIDO_SERVER_ID` in settings.
+
+# Notes for SSL
+
+For passkeys in production, you need to use HTTPS. After the above steps are done:
+
+1. Stop the server
+2. Install SSL requirements
+   ```shell
+   pip install django-sslserver
+   ```
+3. Start the SSL server
+   ```shell
+   python manage.py runsslserver
+   ```