Skip to content

Commit

Permalink
Merge pull request #38 from tingxuanp/update-README
Browse files Browse the repository at this point in the history
Update UI mockup and README
  • Loading branch information
riccoljy authored Oct 1, 2024
2 parents 005cd58 + 171ad86 commit 28a83a2
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 6 deletions.
Binary file modified docs/images/Ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 18 additions & 6 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,31 @@
title: ""
---

# AddressBook Level-3
# WedLinker

[![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/se-edu/addressbook-level3/branch/master/graph/badge.svg)](https://codecov.io/gh/se-edu/addressbook-level3)
[![CI Status](https://github.com/AY2425S1-CS2103T-F15-4/tp/workflows/Java%20CI/badge.svg)](https://github.com/se-edu/addressbook-level3/actions)
[![codecov](https://codecov.io/gh/se-edu/addressbook-level3/branch/master/graph/badge.svg)](https://app.codecov.io/gh/AY2425S1-CS2103T-F15-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).
**WedLinker is a desktop application designed for professional wedding planners to seamlessly manage a variety of
vendors and clients across different locations for a wedding.**

* 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.

While the application has a GUI, most of the user interactions happens using a CLI (Command Line Interface).
This allows for efficient and streamlined management of wedding-related contacts through text-based commands.

WedLinker provides a centralised address book that simplifies the complexities of coordinating multiple vendors,
venues and clients. It enhances communication and streamlines event planning tasks, making the wedding planning process
more organised and efficient.


* If you are interested in using WedLinker, head over to the [_Quick Start_ section of the **User Guide**](UserGuide.html#quick-start).
* If you are interested about developing WedLinker, the [**Developer Guide**](DeveloperGuide.html) is a good place to start.


**Acknowledgements**

This project is based on the AddressBook-Level3 project created by the [SE-EDU initiative](https://se-education.org).

* Libraries used: [JavaFX](https://openjfx.io/), [Jackson](https://github.com/FasterXML/jackson), [JUnit5](https://github.com/junit-team/junit5)

0 comments on commit 28a83a2

Please sign in to comment.