📃 updated docs to include signals documentation.

Author: mabdullahadeel

HISTORY.rst

@@ -2,18 +2,22 @@
 History
 =======
 
-0.1.0 (2022-02-02)
+0.1.2 (2022-02-26)
 ------------------
-
-* First release on PyPI.
-
-    * Authentication with github.
-    * Create user account with github.
-    * Track state.
+* Added ``github_user_created`` signal.
 
 0.1.1 (2022-02-04)
 ------------------
 
 * Minor updates.
 
     * No explicit ``makemigrations`` required.
+
+0.1.0 (2022-02-02)
+------------------
+
+* First release on PyPI.
+
+    * Authentication with github.
+    * Create user account with github.
+    * Track state.

docs/index.rst

@@ -17,7 +17,7 @@ Contents:
 
    Getting Started<readme>
    installation
-   usage
+   signals
    contributing
    authors
    history

docs/signals.rst

@@ -0,0 +1,23 @@
+Signals
+========
+
+
+``django-rest-github-oauth`` provides the following signals:
+
+``github_user_created``
+-----------------------
+    Sent when a new GitHub user is created. The signal is sent with the
+    newly created user instance as one of the keywords arguments.
+    The user is instance of default User model specified in ``settings.py``.
+
+    .. code-block:: python
+
+        from django.contrib.auth.models import User
+        from django.dispatch import receiver
+        from rest_github_oauth.signals import github_user_created
+
+        @receiver(github_user_created)
+        def my_callback(sender, **kwargs):
+            user: User = kwargs['user']
+            # do something with the user
+            # ...