From 062fd30e7103106e4261ab3bd57032327ae45079 Mon Sep 17 00:00:00 2001
From: "Mahesh Warang (warangm)" <warangm@coventry.ac.uk>
Date: Fri, 4 Nov 2022 10:47:36 +0530
Subject: [PATCH] Create README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4cb160a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,58 @@
+# Sports_Club
+
+To access the api as a user, the user must get user verification token.
+
+For the admin, the admin must get verification token and stored in the local database
+
+Every API called is verified using cookie-parser
+
+
+examples for API CALLS:
+
+EVENTS{
+//Create
+router.post('/create-event',verifyAdmin, createEvent)
+
+//update
+router.put("/:id", verifyAdmin, updateEvent);
+//delete
+router.delete("/delete/:id", verifyAdmin, deleteEvents);
+//get
+router.get("/:id", getEvent);
+//get list
+router.get("/getAll", getAllEvents);
+}
+
+CLUBS:{
+//Create
+router.post('/create-club',verifyAdmin, createClub)
+
+//update
+router.put("/update/:id", verifyAdmin, updateClub);
+
+//update user
+router.put("/update-user/:id",verifyUser,registerClub)
+//delete
+router.delete("/delete/:id", verifyAdmin, deleteClubs);
+//get
+router.get("/get/:id", getClub);
+//get list
+
+router.get("/getAll", getAllClub);
+
+
+router.get("/countByClubs", getAllClub);
+
+OUTDOOR / INDOOR
+router.get("/countByType", countByType);
+
+
+//Featured Club
+FEATURED = TRUE
+router.get("/featured", featuredClub);
+
+
+//custom search
+router.get("/search", searchQ);
+
+}