Skip to content

Commit

Permalink
Merge pull request nus-cs2103-AY2324S2#126 from ibnu2651/branch-UG
Browse files Browse the repository at this point in the history
Update user guide
  • Loading branch information
ibnu2651 authored Apr 4, 2024
2 parents cecd09f + e674094 commit 64cfac8
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 4 deletions.
7 changes: 4 additions & 3 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ Refer to the table of contents on the right to find your answers as well as step

1. Ensure you have Java `11` or above installed in your Computer.

1. Download the latest `Insura-Connect.jar` from [here](https://github.com/AY2324S2-CS2103T-T13-3/tp/releases).
1. Download the latest `InsuraConnect.jar` from [here](https://github.com/AY2324S2-CS2103T-T13-3/tp/releases).

1. Copy the file to the folder you want to use as the _home folder_ for your AddressBook.

1. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar Insura-Connect.jar` command to run the application.<br>
1. Open a command terminal, `cd` into the folder you put the jar file in, and use the `java -jar InsuraConnect.jar` command to run the application.<br>
A GUI similar to the below should appear in a few seconds. Note how the app contains some sample data.<br>
![Ui](images/Ui-v1.3.png)

Expand Down Expand Up @@ -143,7 +143,7 @@ Format: `find n/KEYWORD [MORE_KEYWORDS] r/RELATIONSHIP [MORE_RELATIONSHIPS] t/TA
Examples:
* `find n/ John` returns `john` and `John Doe`
* `find r/partner` returns `Alex Yeoh`, `David Li`<br>
![result for 'find alex david'](images/findCharlotteIrfanResult.png)
![result for 'find alex david'](images/findAlexDavidResult.png)

### Deleting a person : `delete`

Expand Down Expand Up @@ -345,6 +345,7 @@ Action | Format, Examples
**Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake`
**List** | `list`
**Help** | `help`
**Change Client Status** | `status INDEX s/DIRECTION`
**Add Policy** | `policy INDEX po/POLICY_NAME [ed/EXPIRY_DATE] [pm/PREMIUM]` <br> e.g., `policy 1 po/Policy ABC ed/01-01-2025`
**Edit Policy** | `policy INDEX pi/POLICY_INDEX po/POLICY_NAME [ed/EXPIRY_DATE] [pm/PREMIUM]` <br> e.g., `policy 1 pi/2 po/Policy ABC pm/1000`
**Delete Policy** | `policy INDEX pi/POLICY_INDEX po/` <br> e.g., `policy 2 pi/2 po/`
Expand Down
2 changes: 1 addition & 1 deletion docs/_markbind/layouts/default.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

<header sticky>
<navbar type="dark">
<a slot="brand" href="{{baseUrl}}/index.html" title="Home" class="navbar-brand">Insura-Connect</a>
<a slot="brand" href="{{baseUrl}}/index.html" title="Home" class="navbar-brand">InsuraConnect</a>
<li><a href="{{baseUrl}}/index.html" class="nav-link">Home</a></li>
<li><a href="{{baseUrl}}/UserGuide.html" class="nav-link">User Guide</a></li>
<li><a href="{{baseUrl}}/DeveloperGuide.html" class="nav-link">Developer Guide</a></li>
Expand Down
Binary file modified docs/images/findAlexDavidResult.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 64cfac8

Please sign in to comment.