update documentation for version 1.1.1 fixes #3

Author: adamspd

README.md

@@ -5,14 +5,16 @@ users to define custom configurations for time slots, lead time, and finish time
 The app also handles conflicts and availability for appointments, ensuring a smooth user experience.
 
 Detailed documentation is in the ["docs"](https://github.com/adamspd/django-appointment/tree/main/docs) directory.
+Please refer to the release notes for changes and migration
+information [here](https://github.com/adamspd/django-appointment/tree/main/release_notes.md).
 
 ## Features
 
 1. Customizable time slots, lead time, and finish time.
 2. Handles appointment conflicts and availability.
 3. Easy integration with Django admin interface for appointment management.
 4. User-friendly interface for viewing available time slots and scheduling appointments.
-5. Sends email notifications to clients when they schedule an appointment.
+5. Send email notifications to clients when they schedule an appointment.
 
 ## Quick start
 

docs/README.md

@@ -1,36 +1,48 @@
 # Appointment Scheduler
+
 This application helps you to schedule appointments with your clients. It is a simple application that allows any client
 to schedule an appointment for a service.
 
 ## Model Structure
-The application has 4 models:
-- Service
-- Appointment Request
-- Appointment
-- Config
+
+The application has 6 models:
+
+- [Service](models.md#service)
+- [Appointment Request](models.md#appointmentrequest)
+- [Appointment](models.md#appointment)
+- [Config](models.md#config)
+- [PaymentInfo](models.md#paymentinfo)
+- [EmailVerificationCode](models.md#emailverificationcode)
 
 ### Service
+
 The service model is used to define the services that you offer. It has the following fields:
+
 - name: The name of the service
 - description: A description of the service
 - duration: The duration of the service (Duration field)
 - price: The price of the service
 - image: An image of the service
 
 ### Appointment Request
-The appointment request model is used to define the appointment requests that your clients make. It has the following fields:
+
+The appointment request model is used to define the appointment requests that your clients make. It has the following
+fields:
+
 - date: The date of the appointment request
 - start_time: The start time of the appointment request
 - end_time: The end time of the appointment request
 - service: The service that the appointment request is for
 - id_request: The id of the appointment request
 
-The appointment request is used to create the appointment. An appointment is considered having more information than 
-that, and since we don't want to overload the appointment model, we use the appointment request to store all 
+The appointment request is used to create the appointment. An appointment is considered having more information than
+that, and since we don't want to overload the appointment model, we use the appointment request to store all
 the information about the appointment.
 
 ### Appointment
+
 The appointment model is used to define the last step in the appointment scheduling. It has the following fields:
+
 - client: The client that made the appointment
 - appointment_request: The appointment request that the appointment is based on
 - phone: The phone number of the client
@@ -42,17 +54,42 @@ The appointment model is used to define the last step in the appointment schedul
 - id_request: The id of the appointment request
 
 ### Config
+
 The config model is used to define the configuration of the application. It has the following fields:
+
 - slot_duration: The duration of each slot in the calendar
 - lead_time: The time of the day that the calendar starts
 - finish_time: The time of the day that the calendar ends
+- appointment_buffer_time: Time between now and the first available slot for the current day (doesn't affect tomorrow).
+- website_name: The name of the website
+
+### PaymentInfo
+
+The PaymentInfo model is used to represent payment information for an appointment. It has the following fields:
+
+- appointment: A foreign key reference to the Appointment model
+
+The model provides several methods to access related appointment details, such as service name, price, currency, client
+name, and email.
+It also includes a method to update the payment status.
+
+### EmailVerificationCode
+
+The EmailVerificationCode model is used to represent an email verification code for a user when the email already exists
+in the database.
+It has the following fields:
+
+- user: A foreign key reference to the user model defined in `APPOINTMENT_CLIENT_MODEL`
+- code: A randomly generated 6-character alphanumeric code
+
+The model includes a class method to generate a new verification code for a user.
 
 ## Configuration
 
 In your Django project's settings.py, you can override the default values for the appointment scheduler:
 
 ```python
-APPOINTMENT_CLIENT_MODEL = 'auth.User' # file.Model
+APPOINTMENT_CLIENT_MODEL = 'auth.User'  # file.Model
 APPOINTMENT_BASE_TEMPLATE = 'base_templates/base.html'
 APPOINTMENT_WEBSITE_NAME = 'Website'
 APPOINTMENT_PAYMENT_URL = None
@@ -61,3 +98,4 @@ APPOINTMENT_SLOT_DURATION = 30  # minutes
 APPOINTMENT_LEAD_TIME = (9, 0)  # (hour, minute) 24-hour format
 APPOINTMENT_FINISH_TIME = (16, 30)  # (hour, minute) 24-hour format
 ```
+

release_notes.md

@@ -0,0 +1,60 @@
+# django-appointment
+
+**v1.1.1**
+
+# Release Notes for Version 1.1.1
+
+## Introduction
+
+Version 1.1.1 brings an important fix to the package, addressing a specific issue in slot availability. The update also
+includes enhanced testing to ensure the integrity of the solution. This release builds on the previous versions,
+focusing on reliability and responsiveness.
+
+## Bug Fixes
+
+### Slot Availability Fix
+
+- Fixed an issue where booking the second slot did not correctly block the first slot if it was booked later. This fix
+  ensures that both slots are handled correctly, and one does not affect the availability of the other.
+
+### Testing Enhancements
+
+- Added specific tests to reproduce and verify the slot availability issue, strengthening the robustness of the
+  codebase.
+
+## Previous Version Highlights (1.1.0)
+
+Please refer to the release notes for version 1.1.0 for details on new models, user interface enhancements, code quality
+improvements, and core features introduced in that version.
+
+## Getting Started
+
+If you haven't already installed the package, or if you're upgrading from a previous version, follow the instructions
+below:
+
+### Installation:
+
+```bash
+pip install django-appointment==1.1.0
+```
+
+### Database Migration:
+
+```bash
+python manage.py makemigrations
+python manage.py migrate
+```
+
+## Support & Feedback
+
+We value your feedback and are committed to continuous improvement. For support, documentation, and further details,
+please refer to the provided resources.
+
+## Conclusion
+
+Version 1.1.1 is a targeted update focusing on fixing a specific issue and enhancing the reliability of the package. By
+addressing user-reported concerns and strengthening the testing framework, this release underscores our commitment to
+providing a robust and dependable solution.
+
+For detailed documentation and instructions on how to use the package, please refer to the accompanying README files and
+online resources.