Skip to content

Commit 8b2ef73

Browse files
authored
Merge pull request #363 from adamspd/featuremake-the-demo-documentation-part-prominent
Make the demo part prominent in the documentation
2 parents 2184673 + 352b8a2 commit 8b2ef73

File tree

1 file changed

+31
-14
lines changed

1 file changed

+31
-14
lines changed

README.md

Lines changed: 31 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,35 @@
1616
[![Django compatible version](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/adamspd/django-appointment/main/django_compatible.json)](https://github.com/adamspd/django-appointment/blob/main/compatibility_matrix.md)
1717
[![Python compatible version](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/adamspd/django-appointment/main/python_compatible.json)](https://github.com/adamspd/django-appointment/blob/main/compatibility_matrix.md)
1818

19+
Django-Appointment is a Django app engineered for managing appointment scheduling with ease and flexibility. It enables
20+
users to define custom configurations for time slots, lead time, and finish time, or use the default values
21+
provided. This app proficiently manages conflicts and availability for appointments, ensuring a seamless user
22+
experience.
23+
24+
## 🚨 STOP! Try the Demo First 🚨
25+
26+
**Before you install anything, go play with the live demo:**
27+
28+
### 👉 [**LIVE DEMO**](https://django-appt.adamspierredavid.com/) 👈
29+
30+
**Seriously, it will help you get less confused about how the system works.** The demo shows you exactly what you're getting into and will save you (and me) a lot of headaches.
31+
32+
**What you'll see in the demo:**
33+
- 📅 How the appointment booking interface works
34+
- ⚙️ How the admin configuration affects the frontend
35+
- 📧 Email notifications in action
36+
- 🔄 Conflict resolution and availability management
37+
38+
⚠️ **Important**: Use **real email addresses** or `[email protected]` if you don't care about testing the email notification and/or you're concerned about using your personal email. Sending notifications to too many fake emails **will get my server blacklisted** by Gmail/Yahoo/etc., and I'll have to **kill the demo for everyone** before this happens - **my email server matters more** than your testing convenience.
39+
40+
**Privacy note**: A crontab erases the demo database every 2 hours, so I don't collect or store your email addresses - I have zero interest in doing so.
41+
42+
For the record: yes, I know when you use fake emails because Google and the others **bounce them back to me**, and I monitor the demo email account specifically for this.
43+
44+
*Note: Please read the [terms of use](https://django-appt.adamspierredavid.com/terms-and-conditions/) before using the demo.*
45+
46+
---
47+
1948
🆕 **New**: The documentation website is now
2049
available [here](https://django-appt-doc.adamspierredavid.com). It includes reasons for using the
2150
application, its features, and detailed configuration instructions.
@@ -26,11 +55,6 @@ the [migration guide](https://github.com/adamspd/django-appointment/tree/main/do
2655
updating. Version 3.x.x introduces the ability to send email reminders for appointments using Django Q for efficient
2756
task scheduling. It also allows clients to reschedule appointments if it is allowed by admins.
2857

29-
Django-Appointment is a Django app engineered for managing appointment scheduling with ease and flexibility. It enables
30-
users to define custom configurations for time slots, lead time, and finish time, or use the default values
31-
provided. This app proficiently manages conflicts and availability for appointments, ensuring a seamless user
32-
experience.
33-
3458
For a detailed walkthrough and live example of the system, please refer to
3559
[this tutorial](https://github.com/adamspd/django-appointment/tree/main/docs/explanation.md).
3660

@@ -66,6 +90,8 @@ see their [release notes](https://github.com/adamspd/django-appointment/tree/mai
6690

6791
## Quick Start 🚀
6892

93+
⚠️ **Haven't tried the demo yet?** Go [here](https://django-appt.adamspierredavid.com/) first - it'll make everything clearer.
94+
6995
1. Install Django-Appointment in your project using pip:
7096

7197
```bash
@@ -395,15 +421,6 @@ more information.
395421
Please refer to the [security policy](https://github.com/adamspd/django-appointment/tree/main/SECURITY.md) for more
396422
information.
397423
398-
## Notes 📝⚠️
399-
400-
I'm working on a testing website for the application that is not fully functional yet, no hard feelings. Before using
401-
it,
402-
it's important to me that you read the terms of use, only then you can use it if you agree to them. The demo website is
403-
located
404-
at [https://django-appt.adamspierredavid.com/](https://django-appt.adamspierredavid.com/terms-and-conditions/). Ideas
405-
are welcome.
406-
407424
## About the Author
408425
409426
Adams Pierre David - [Website](https://adamspierredavid.com/)

0 commit comments

Comments
 (0)