Skip to content

Commit 14246bf

Browse files
committed
Update README page
Make changes to Ui mock up, update link of Github Actions badge and the content of the page.
1 parent 2d9d3d2 commit 14246bf

File tree

2 files changed

+17
-11
lines changed

2 files changed

+17
-11
lines changed

README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,20 @@
1-
[![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/AY2324S2-CS2103-F09-1/tp/graph/badge.svg?token=NB86I9H23Z)](https://codecov.io/gh/AY2324S2-CS2103-F09-1/tp)
1+
[![CI Status](https://github.com/AY2324S2-CS2103-F09-1/tp/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions) [![codecov](https://codecov.io/gh/AY2324S2-CS2103-F09-1/tp/graph/badge.svg?token=NB86I9H23Z)](https://codecov.io/gh/AY2324S2-CS2103-F09-1/tp)
22

33
![Ui](docs/images/Ui.png)
44

5-
* This is **a sample project for Software Engineering (SE) students**.<br>
6-
Example usages:
7-
* as a starting point of a course project (as opposed to writing everything from scratch)
8-
* as a case study
9-
* The project simulates an ongoing software project for a desktop application (called _AddressBook_) used for managing contact details.
10-
* 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.
11-
* It comes with a **reasonable level of user and developer documentation**.
12-
* 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` ...).
13-
* For the detailed documentation of this project, see the **[Address Book Product Website](https://se-education.org/addressbook-level3)**.
14-
* 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.
5+
## About the app
6+
7+
EstateEase simplifies residential property management for real estate listing agents in Singapore.
8+
9+
### Key Features:
10+
* With intuitive tools for listing and client communication, the app is tailored for efficiency.
11+
* Agents can quickly access contacts and prioritize them, ensuring swift connections with clients.
12+
13+
### Example Usages:
14+
* Allows real estate agents to add and delete client information.
15+
* Allows real estate agents to prioritize client contacts for efficient communication
16+
* Allows real estate agents to load and save the list using JSON file
17+
18+
## Acknowledgements
19+
This project is based on the AddressBook-Level3 project created by the
20+
[SE-EDU initiative](https://se-education.org).

docs/images/Ui.png

53 KB
Loading

0 commit comments

Comments
 (0)