Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ziyi105 authored Oct 6, 2023
1 parent 35708a3 commit 5b283d0
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
| deadline | A task with a deadline |
| event | An event with a start and end date and time |


##Important Note
<mark>Words in UPPER_CASE are the parameters to be supplied by the user.
e.g. in ```todo TASK_DESCRIPTION```, TASK_DESCRIPTION is a parameter which can be used as add n/assignment</mark>

Expand All @@ -16,6 +16,15 @@ e.g. in ```todo TASK_DESCRIPTION```, TASK_DESCRIPTION is a parameter which can b
### Listing All Tasks: ```list```
Shows a list of all persons in the address book.
Format: ```list```
Example:
```
list
-----------------------------------------------------------
Here are the tasks in your list:
1.[T][X] read book
2.[D][X] return book (by: June 6th)
------------------------------------------------------------
```

### Adding Todo
Adds a new todo task in your list.
Expand Down Expand Up @@ -44,7 +53,6 @@ Format: ```delete TASK_INDEX```
### Find Task
Find tasks with matching keywords in your list.
Format: ```find KEY_WORD```

Example:
```
find book
Expand Down

0 comments on commit 5b283d0

Please sign in to comment.