add installation rst

Author: soldatov-ss

docs/index.rst

@@ -10,11 +10,31 @@ Welcome to django-referral-system's documentation!
    :maxdepth: 2
    :caption: Contents:
 
+   installation
 
 
-Indices and tables
-==================
+Key Features
+============
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+* **Promoter Management**: Easily create and manage promoters who can invite referrals to join your platform.
+* **Referral Tracking**: Promoters can track their list of referrals, including invitation details, sign-up status, and more.
+* **Earnings Monitoring**: Promoters can view their recent earnings, including commissions from successful referrals.
+* **Commission-Based Rewards**: Promoters earn money by receiving commissions from referrals they invite, with configurable commission rates.
+* **Customizable Payout Methods**: Promoters can set and update their preferred payout methods and minimum withdrawal balances.
+* **Referral Link Creation**: Generate unique referral links that promoters can share to invite others to the platform.
+* **Referral Program Flexibility**: Only one referral program can be active at a time, allowing for focused and streamlined referral management.
+* **Detailed Payout History**: Promoters can view their full payout history, allowing for transparency and easy tracking of payment status.
+* **Click Tracking**: Keep track of how many times a referral link has been clicked.
+
+.. note::
+   For detailed setup instructions, see the :ref:`installation` page.
+
+License
+=======
+
+This package is licensed under the MIT License. See the LICENSE file for more details.
+
+Contributing
+============
+
+If you find any issues or have suggestions, feel free to open an issue or submit a pull request.

docs/installation.rst

@@ -0,0 +1,45 @@
+Installation Guide
+==================
+
+Follow these steps to install and set up `django-referral-system`:
+
+1. Install the package via pip:
+
+   .. code-block:: bash
+
+      pip install django-referral-system
+
+2. Add referrals to your `INSTALLED_APPS` in `settings.py`:
+
+   .. code-block:: python
+
+      INSTALLED_APPS = [
+          # other apps
+          'referrals',
+      ]
+
+3. Add to `urls.py`:
+
+   .. code-block:: python
+
+      from django.urls import path, include
+
+      urlpatterns = [
+          # Other URL patterns...
+          path('referrals/', include("referrals.urls")),
+      ]
+
+4. Apply Migrations:
+
+   .. code-block:: bash
+
+      python manage.py migrate
+
+5. Create a Referral Program:
+
+   After installation, you can create a new referral program using the provided management command.
+   If this program is set to active, any previous active referral programs will be deactivated automatically.
+
+   .. code-block:: bash
+
+      python manage.py create_referral_program --name="My Referral Program" --commission-rate=5.00 --min-withdrawal-balance=10.00