Update readme

README.md

@@ -1,15 +1,28 @@
 # Google Suite Tasks Dashboard
+
+## Project's purpose
 The objective of the Google Suite Tasks Dashboard is to provide Google users with a centralized platform to efficiently manage tasks across the Google Task and Google Docs applications. By creating this solution, users can easily access and track their tasks in one location.
 
-## Development Setup
+## Features
+1. Crawling tasks from Google Docs.
+2. View-only dashboard for user's tasks.
+3. Fetching tasks directly from Google Tasks API.
 
-### Project structure
-Entry point of the Flask application is `__init__.py`.
+## Installation instructions
+1. Clone the repository [glaceon-google-suite-tasks](https://github.com/nyuoss/glaceon-google-suite-tasks).
+2. Install PDM as package and dependency manager if it has not been installed.
 
-Frontend HTML templates can be found in `templates/` folder, such as `index.html`.
+    `pdm install --dev`
 
-Static elements and styles can be found in `static/` folder, such as `style.css`.
+3. Install dependencies:
+
+    `pdm install --dev`
+
+4. To update dependencies, run the following:
 
+    `pdm update`
+
+## Usage instructions
 ### Running Flask app
 Change directory to `src/open_source_python_template` folder:
 
@@ -30,88 +43,12 @@ Open browser and go to the following host address:
 4. Run the script by clicking "Run".
 5. When the script finishes execution, the comments with tasks assigned to the current use will be stored in a newly created Google Sheet.
 
-# Open Source Python Template
-
-This is an advanced template for designing and developing Python projects with CI/CD. This template serves as a foundation and includes features for build management, unit testing, continuous integration, static analysis, code style adherence, and component specification.
-
-The details of this template are listed below:
-
-- The programming language: Python
-
-- Testing Framework: Pytest
-
-- Continuous Integration Solution: GitHub Actions, CircleCI
-
-- Static Analysis Tools: Ruff, Flake8, MyPy
-
-- Code Formatting Solution: Black
-
-- Package/Dependency Manager: PDM (Python Dependency Management)
-
-## Initial Setup
-
-Install PDM as package and dependency manager:
-
-    pip install pdm
-
-Install initial dependencies:
-
-    pdm install --dev
-
-To update dependencies, run the following:
-
-    pdm update
-
-## Using Features
+## Contribution Guidelines
 
-To use mypy, run the following:
-
-    pdm run mypy <filename>
-
-To use ruff, run the following:
-
-    pdm run ruff <filename>
-
-To use pytest, run the following:
-
-    pdm run pytest tests/test_addition.py
-
-To run the application, run the following:
-
-    pdm run src/main.py
-
-## Component Path
-
-For now, we're focusing on two components: the test and the function itself.
-
-To develop or maintain features, navigate to the /src directory.
-
-    cd src
-
-To add or modify test component, navigate to the /tests directory.
-
-    cd tests
-
-## Continuous Integration with GitHub Actions
-This project is configured to use GitHub Actions for continuous integration. Every push to the repository triggers automated tests and checks to ensure code quality and functionality.
-
-To see the status of your build, navigate to the main page of the repository. Go to Actions, and in the left sidebar, click the workflow you want to display. From the list of workflow runs, click the name of the run you want to see. There, you can view the logs that shows you how each of the steps was processed.
-
-If you need to customize the build process, modify the `.github/workflows/github-actions.yml` file according to your needs. For detailed instructions, refer to the [GitHub Actions Documentation](https://docs.github.com/en/actions).
-
-## Continuous Integration with CircleCI
-
-As an alternative, this project is also configured to use CircleCI for continuous integration. 
-
-To see the status of your build, visit the CircleCI dashboard. There, you can view the progress and results of the build tests, static analysis, and more for your latest commits.
-
-If you need to customize the build process, modify the `.circleci/config.yml` file according to your needs. For detailed instructions, refer to the [CircleCI Configuration Reference](https://circleci.com/docs/2.0/configuration-reference/).
+### Backend
+Entry point of the Flask application is `__init__.py`.
 
-## Contributors - Team Glaceon 
+### Frontend
+Frontend HTML templates can be found in `templates/` folder, such as `index.html`.
 
-- Yifei Zhuang
-- Fan Yang
-- Bowen Gong
-- Yanglin Tao
-- Winnie Zheng
-- Kaining Mao
+Static elements and styles can be found in `static/` folder, such as `style.css`.

TEAM.md

@@ -0,0 +1,7 @@
+# Contributors
+1. Yanglin Tao - Full-stack developer
+2. Winnie Zheng - Front-end developer
+3. Fan Yang - Database developer
+4. Bowen Gong - Frontend developer
+5. Kaining Mao - Backend developer
+6. Yifei Zhuang - Backend developer