From 2da7ddf25846c2adc6d14c740d80e18c960a4b63 Mon Sep 17 00:00:00 2001
From: nfel <nfilsaraee@gmail.com>
Date: Sat, 23 Nov 2024 16:43:01 +0330
Subject: [PATCH] Initial Commit

---
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7cf4b4c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# Alert Service
+
+Mainly is developed to be used for following purposes:
+
+- Handles Users Notifications
+- Handles Users Subscriptions
+- Handles Users Alerts
+- Transactional Logs
+- Notifying Users via:
+  - SMS :
+    - Currently uses Kavenegar API
+  - Email :
+    - SMTP Server is required to achieve this