Merge pull request #22 from logical-1985516/branch-AboutMe

Update README to match project

README.md

@@ -2,13 +2,15 @@
 [![codecov](https://codecov.io/gh/AY2324S2-CS2103T-W08-1/tp/graph/badge.svg?token=IG2LRI4TTR)](https://codecov.io/gh/AY2324S2-CS2103T-W08-1/tp)
 ![Ui](docs/images/Ui.png)
 
-* This is **a sample project for Software Engineering (SE) students**.<br>
+* This is **an app for recruiters to manage candidates**.<br>
   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.
+  * retrieves the candidate list if an excel sheet containing the candidate list is put in the correct location
+  * create/read/update/delete candidates in the candidate list
+  * track the status of each candidate in the hiring pipeline
+* The project is an ongoing software project for a desktop application (called _HireHub_) used for managing candidate details.
+  * It is based on the AddressBook-Level3 project, with additional tweaks and features to provide a customised experience for recruiters.
+  * From the AddressBook-Level3 project: > It is **written in OOP fashion**. It provides a **reasonably well-written** code base **bigger** 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://se-education.org/addressbook-level3)**.
-* 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.
+* It is named `Hirehub` because it is meant to help recruiters to manage and hire candidates seamlessly.
+* For the detailed documentation of this project, see the **[User Guide](https://github.com/AY2324S2-CS2103T-W08-1/tp/blob/master/docs/UserGuide.md)** if you are interested in using HireHub, or the **[Developer Guide](https://github.com/AY2324S2-CS2103T-W08-1/tp/blob/master/docs/DeveloperGuide.md)** if you are interested in developing HireHub.
+* This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

docs/AboutUs.md

@@ -29,15 +29,15 @@ You can reach us at the email `seer[at]comp.nus.edu.sg`
 * Role: Developer
 * Responsibilities: Frontend, Backend, DevOps, Code Reviews
 
-### Jane Doe
+### Yan Jie
 
-<img src="images/johndoe.png" width="200px">
+<img src="images/logical-1985516.png" width="200px">
 
-[[github](http://github.com/johndoe)]
-[[portfolio](team/johndoe.md)]
+[[github](http://github.com/logical-1985516)]
+[[portfolio](team/yanjie.md)]
 
-* Role: Team Lead
-* Responsibilities: UI
+* Role: Developer
+* Responsibilities: Frontend, Documentation, Code Reviews
 
 ### Ikhoon Eom
 

docs/team/yanjie.md

@@ -0,0 +1,46 @@
+---
+layout: page
+title: Yan Jie's Project Portfolio Page
+---
+
+### Project: AddressBook Level 3
+
+AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC.
+
+Given below are my contributions to the project.
+
+* **New Feature**: Added the ability to undo/redo previous commands.
+  * What it does: allows the user to undo all previous commands one at a time. Preceding undo commands can be reversed by using the redo command.
+  * Justification: This feature improves the product significantly because a user can make mistakes in commands and the app should provide a convenient way to rectify them.
+  * Highlights: This enhancement affects existing commands and commands to be added in future. It required an in-depth analysis of design alternatives. The implementation too was challenging as it required changes to existing commands.
+  * Credits: *{mention here if you reused any code/ideas from elsewhere or if a third-party library is heavily used in the feature so that a reader can make a more accurate judgement of how much effort went into the feature}*
+
+* **New Feature**: Added a history command that allows the user to navigate to previous commands using up/down keys.
+
+* **Code contributed**: [RepoSense link]()
+
+* **Project management**:
+  * Managed releases `v1.3` - `v1.5rc` (3 releases) on GitHub
+
+* **Enhancements to existing features**:
+  * Updated the GUI color scheme (Pull requests [\#33](), [\#34]())
+  * Wrote additional tests for existing features to increase coverage from 88% to 92% (Pull requests [\#36](), [\#38]())
+
+* **Documentation**:
+  * User Guide:
+    * Added documentation for the features `delete` and `find` [\#72]()
+    * Did cosmetic tweaks to existing documentation of features `clear`, `exit`: [\#74]()
+  * Developer Guide:
+    * Added implementation details of the `delete` feature.
+
+* **Community**:
+  * PRs reviewed (with non-trivial review comments): [\#12](), [\#32](), [\#19](), [\#42]()
+  * Contributed to forum discussions (examples: [1](), [2](), [3](), [4]())
+  * Reported bugs and suggestions for other teams in the class (examples: [1](), [2](), [3]())
+  * Some parts of the history feature I added was adopted by several other class mates ([1](), [2]())
+
+* **Tools**:
+  * Integrated a third party library (Natty) to the project ([\#42]())
+  * Integrated a new Github plugin (CircleCI) to the team repo
+
+* _{you can add/remove categories in the list above}_