Skip to content

Commit

Permalink
Merge pull request #67 from freshcabbage123/docs/UG-v1.1
Browse files Browse the repository at this point in the history
chore: Move changes from draft UG to actual UG
  • Loading branch information
m1oojv authored Oct 5, 2023
2 parents 1af96cb + 814e55f commit dec5579
Showing 1 changed file with 69 additions and 0 deletions.
69 changes: 69 additions & 0 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,54 @@ Output:

<div style="page-break-after: always;"></div>

### 2. Adding a person: `addPerson`

Add new people that you meet, be it new clients, vendors or friends.

Format:

```
addPerson n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…
```

{% include admonition.html type="info" title="A person can have any number of tags (including 0)." %}

Examples:

- `addPerson n/John Doe p/98765432 e/[email protected] a/John street, block 123, #01-01`
- `addPerson n/Betsy Crowe t/friend e/[email protected] a/Newgate Prison p/1234567 t/criminal`

Output:

![addPerson success](images/addPerson_success.png)

Errors:

![addPerson error](images/error/addPerson_error.png)

<div style="page-break-after: always;"></div>


### 3. Listing all persons: `listPerson`

Presents you with a comprehensive list of contacts in your contact list.

Format:

```
listPerson
```

Examples:

- `listPerson`

Output:

![listPerson success](images/listPerson_success.png)

<div style="page-break-after: always;"></div>

### 7. Clearing all person entries: `deleteAllPerson`


Expand All @@ -110,6 +158,27 @@ Output:

![deleteAllPerson success](images/deleteAllPerson_success.png)

<div style="page-break-after: always;"></div>

### 9. Listing all tasks: `listTask`

Provides you with a complete list of tasks in your task list.

Format:

```
listTask
```

Examples:

- `listTask`

Output:

![listTask_success](images/output/listTask_success.png)


<div style="page-break-after: always;"></div>

### 10. Editing a task: `editTask`
Expand Down

0 comments on commit dec5579

Please sign in to comment.