api docs init

API_DOCS.md

@@ -0,0 +1,45 @@
+# ACM API
+
+## Authentication
+
+### Login
+
+### Register
+
+### Verify
+
+## User
+
+### Get User Info
+
+### Get user by id
+
+### Update user
+
+### Get rank by score
+
+### Get leaderboard
+
+### Get leaderboard by batch
+
+## Events
+
+### Create Event
+
+### Update Event
+
+### Delete Event
+
+### End Event
+
+### Get all events
+
+### Get ongoing events
+
+### Get single event
+
+### Get events by branch
+
+### Get Event by role
+
+### Get next event

README.md

@@ -1,6 +1,9 @@
 # acm-website-backend
 Backend of the official website of PEC ACM CSS
 
+## docs
+[API DOCS](API_DOCS.md)
+
 ## Pre Requisites
 
 1. Java 17(Oracle or Corretto) installed.
@@ -13,9 +16,7 @@ Backend of the official website of PEC ACM CSS
     ```bash
     docker compose up
     ```
-3. Add the Email/password of gmail in `application-local.yml` file under `spring.mail` key, to connect to smtp server and send mails.
-   - DO NOT PUSH THIS FILE 
-4. Code and push
+3. Code and push
 
 ## Instructions