From 5dc6e95f405778b17fb24b32aaf4bcfbf2bb08e1 Mon Sep 17 00:00:00 2001
From: will <will413028@gmail.com>
Date: Thu, 15 Feb 2024 17:52:40 +0800
Subject: [PATCH] chore: update README

---
 README.md | 34 ++++++++++++++++++++++++++++++++++
 main.py   |  5 -----
 2 files changed, 34 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 952de32..16478d9 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,39 @@
 # Attendance-System-fastapi
 
+## Demo Link
+
+https://attendance-system-frontend-5raarijksa-de.a.run.app/
+
+
+## Features
+- ### Database: using MySQL
+- ### Authentication: using jsonwebtoken
+- ### Testing: unit tests using pytest
+- ### CI/CD: using GitHub Action and GCP
+
+
+## API Endpoints
+List of available routes:
+
+**Auth routes**:\
+`POST /login` - login
+
+**User routes**:\
+`GET /users` - get all users\
+`PUT /users/:id` - update user
+
+**Attendance routes**:\
+`GET /attendances` - get all attendance\
+`POST /attendances` - create an attendance\
+`PUT /attendances/:id` - update attendance\
+`GET /attendanceQRcode` - get attendance QRcode
+
+**Holiday routes**:\
+`POST /holidays` - create holiday\
+`GET /holidays` - get all holiday
+
+
+## How to run:
 
 Run server
 
diff --git a/main.py b/main.py
index 4883073..67b2bed 100644
--- a/main.py
+++ b/main.py
@@ -34,11 +34,6 @@ def get_settings():
     return Settings()
 
 
-@app.get('/')
-def hello():
-    return {'message': 'Hello World'}
-
-
 @app.get("/users/{id}", response_model=schemas.User)
 def get_user_by_id(id: int, db: Session = Depends(get_db), current_user: dict = Depends(jwt.get_current_user)):
     user = service.get_user_by_id(db, id)