Merge pull request #111 from howardwhw2/index

Update index page and documentation
AY2122S2-CS2103-W16-4 · Mar 31, 2022 · e86d904 · e86d904
2 parents 4495883 + 3d47578
commit e86d904
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 4 deletions.
diff --git a/docs/UserGuide.md b/docs/UserGuide.md
@@ -302,6 +302,7 @@ Opens up a new window that displays a pie chart containing the data of the numbe
 # FAQ
 
 # Command Summary
+
 | Action            | Format                                                                                                 | Examples                                                                                                                             |
 |-------------------|--------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|
 | Add               | add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [pr/PROPERTY]... [pf/PREFERENCE] i/FILEPATH[:DESCRIPTION]… | e.g. add n/James Ho p/22224444 e/[email protected] a/123, Clementi Rd, 1234665 pr/2-room, East, SGD$200K, i/living.png:Living room |

diff --git a/docs/images/Ui.png b/docs/images/Ui.png
diff --git a/docs/index.md b/docs/index.md
@@ -1,19 +1,22 @@
 ---
 layout: page
-title: AddressBook Level-3
+title: RealEstatePro
 ---
 
 [![CI Status](https://github.com/se-edu/addressbook-level3/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
 [![codecov](https://codecov.io/gh/AY2122S2-CS2103-W16-4/tp/branch/master/graph/badge.svg?token=EZT8AD477Q)](https://codecov.io/gh/AY2122S2-CS2103-W16-4/tp)
 
 ![Ui](images/Ui.png)
 
-**AddressBook is a desktop application for managing your contact details.** While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface).
+**RealEstatePro is a desktop application for managing your client details for real estate agents.** While it has a GUI, most of the user interactions happen using a CLI (Command Line Interface).
+With RealEstatePro managing your clients will be breeze by using the various features such as reminders, client matching and many more!
 
-* If you are interested in using AddressBook, head over to the [_Quick Start_ section of the **User Guide**](UserGuide.html#quick-start).
-* If you are interested about developing AddressBook, the [**Developer Guide**](DeveloperGuide.html) is a good place to start.
+* If you are interested in using RealEstatePro, head over to the [_Quick Start_ section of the **User Guide**](UserGuide.html#quick-start).
+* If you are interested about developing RealEstatePro, the [**Developer Guide**](DeveloperGuide.html) is a good place to start.
 
 
 **Acknowledgements**
 
 * Libraries used: [JavaFX](https://openjfx.io/), [Jackson](https://github.com/FasterXML/jackson), [JUnit5](https://github.com/junit-team/junit5)
+* Base: [AB3](https://github.com/se-edu/addressbook-level3)
+