diff --git a/README.md b/README.md index 6b2e83a9064..8c418c9d5df 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,39 @@ -[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions) +[![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/AY2324S2-CS2103T-T14-1/tp/actions) +[![codecov](https://codecov.io/gh/AY2324S2-CS2103T-T09-4/tp/graph/badge.svg?token=WAIOG42WJK)](https://codecov.io/gh/AY2324S2-CS2103T-T14-1/tp) + +# EffiTrack ![Ui](docs/images/Ui.png) +> Boost productivity, streamline success! Welcome to EffiTrack – where efficiency meets innovation. Revolutionize your workday with seamless employee performance tracking. + +## Value Proposition +HR departments often struggle to accurately measure employee efficiency, leading to reduced productivity. Traditional methods of tracking employee performance, such as manual documentation or outdated systems, are time-consuming and prone to errors. EffiTrack solves these challenges by providing a centralized platform to effortlessly monitor employee efficiency. + +## Features +- [ ] Add employee information +- [ ] List all employees information +- [ ] Edit an existing employee information +- [ ] Find employees whose names contain any of the given keywords +- [ ] Delete a specific employee +- [ ] Clear all entries +- [ ] Assign task to an employee +- [ ] Mark an assigned task as done +- [ ] Edit deadline of assigned task +- [ ] Change person in charge of the task +- [ ] Sort employee based on efficiency +- [ ] Display upcoming deadlines +- [ ] Display fire list +- [ ] Generate efficiency report + +## Get Started +1. Download EffiTrack here. +2. Navigate to your Downloads folder using the terminal. +3. Type `java -jar EffiTrack.jar` in your terminal. +4. Press enter. +5. Give it a try now! + +## Documentation +For the detailed documentation of this project, see the **[EffiTrack Product Website](https://ay2324s2-cs2103t-t14-1.github.io/tp/)**. -* This is **a sample project for Software Engineering (SE) students**.
- Example usages: - * as a starting point of a course project (as opposed to writing everything from scratch) - * as a case study -* The project simulates an ongoing software project for a desktop application (called _AddressBook_) used for managing contact details. - * It is **written in OOP fashion**. It provides a **reasonably well-written** code base **bigger** (around 6 KLoC) than what students usually write in beginner-level SE modules, without being overwhelmingly big. - * It comes with a **reasonable level of user and developer documentation**. -* It is named `AddressBook Level 3` (`AB3` for short) because it was initially created as a part of a series of `AddressBook` projects (`Level 1`, `Level 2`, `Level 3` ...). -* For the detailed documentation of this project, see the **[Address Book Product Website](https://ay2324s2-cs2103t-t14-1.github.io/tp/)**. -* This project is a **part of the se-education.org** initiative. If you would like to contribute code to this project, see [se-education.org](https://se-education.org#https://se-education.org/#contributing) for more info. +## Acknowledgement +This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org) diff --git a/docs/images/yiwern5.png b/docs/images/yiwern5.png index d3c13166783..246b57bddf5 100644 Binary files a/docs/images/yiwern5.png and b/docs/images/yiwern5.png differ