update key features and bump version

Author: soldatov-ss

README.md

@@ -5,23 +5,23 @@
 [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/soldatov-ss/django-referral-system/blob/main/LICENSE)
 [![Python Versions](https://img.shields.io/pypi/pyversions/django-referral-system.svg)](https://pypi.org/project/django-referral-system/)
 
-A Django app for managing referral programs, promoters, referrals, and tracking referral performance with features like
-commission setting, invitation management, and Wise payouts.
-
+A Django app for managing referral programs, promoters, referrals, and tracking referral performance with features like commission setting, invitation management, and Wise payouts.
 ## Documentation
 
 Full documentation is available at [Read the Docs](https://django-referral-system.readthedocs.io/en/latest/index.html).
 
 ## Features
 * **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.
+* **Earnings Monitoring**: Promoters can view their recent earnings, aggregated by day for the last 7 days, including commissions from successful referrals.
+* **Commission-Based Rewards**: Promoters earn money by receiving commissions from referrals they invite, with configurable commission rates based on the active referral program.
+* **Customizable Payout Methods**: Promoters can set and update their preferred payout methods (e.g., Wise) and minimum withdrawal balances.
+* **Wise Payout Integration**: Automatically generate CSV files for Wise payouts and process payouts for promoters whose balance meets the minimum withdrawal amount.
+* **Email Invitation**: Promoters can send invitation emails to potential referrals with a custom HTML template. Ensure that the `BASE_REFERRAL_LINK` and `BASE_EMAIL` environment variables are properly set.
+* **Refund Handling**: Automatically adjust promoter commissions in case of user refunds, ensuring that promoters only earn commissions for completed transactions.
 * **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.
+* **Detailed Payout History**: Promoters can view their full payout history, providing transparency and easy tracking of payment status.
+* **Click Tracking**: Keep track of how many times a referral link has been clicked, helping promoters measure the performance of their referral efforts.
 
 ## Installation
 

docs/index.rst

@@ -23,13 +23,15 @@ Key Features
 
 * **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.
+* **Earnings Monitoring**: Promoters can view their recent earnings, aggregated by day for the last 7 days, including commissions from successful referrals.
+* **Commission-Based Rewards**: Promoters earn money by receiving commissions from referrals they invite, with configurable commission rates based on the active referral program.
+* **Customizable Payout Methods**: Promoters can set and update their preferred payout methods (e.g., Wise) and minimum withdrawal balances.
+* **Wise Payout Integration**: Automatically generate CSV files for Wise payouts and process payouts for promoters whose balance meets the minimum withdrawal amount.
+* **Email Invitation**: Promoters can send invitation emails to potential referrals with a custom HTML template. Ensure that the `BASE_REFERRAL_LINK` and `BASE_EMAIL` environment variables are properly set.
+* **Refund Handling**: Automatically adjust promoter commissions in case of user refunds, ensuring that promoters only earn commissions for completed transactions.
 * **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.
+* **Detailed Payout History**: Promoters can view their full payout history, providing transparency and easy tracking of payment status.
+* **Click Tracking**: Keep track of how many times a referral link has been clicked, helping promoters measure the performance of their referral efforts.
 
 .. note::
    For detailed setup instructions, see the :ref:`installation` page.

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = django-referral-system
-version = 0.1.1
+version = 0.1.2
 description = A Django app for managing referral programs, promoters, referrals, and tracking referral performance with advanced features like commission setting, invitation management, and Wise payouts.
 long_description = file: README.md
 long_description_content_type = text/markdown