diff --git a/README.md b/README.md index 8299339..dfeb95f 100644 --- a/README.md +++ b/README.md @@ -1 +1,17 @@ # GroupFlow + +### GroupFlow is a group management service for students that enables seamless collaboration and scheduling between members. + +## Features +- Create groups, invite members, and collaborate with meetings, tasks, and schedules to share amongst each other. +- Sign up with email to recieve notifications of members requesting to join your group. + +## Installation +- Create a copy of this repository by running `git clone https://github.com/ingrid534/GroupFlow.git`. +- NOTE: In order to properly run this application, an API key is needed from [SendGrid API](https://sendgrid.com/en-us/solutions/email-api), which provides the sending of our email notifications. + - Once an API key is available, place it directly in `config/api_key.txt`. + +## Runnning the Application +- Run the Java application in `src/main/java/app/Main.java`. +- Login with existing credentials, or sign up. +- Create or join groups via the dashboard home page.