Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Vanessamae23 authored Sep 13, 2023
1 parent ddc4f45 commit aef2b93
Showing 1 changed file with 77 additions and 1 deletion.
78 changes: 77 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Format : `event NAME /from DAY TIME /to DAY TIME` where `TIME` is in this format
| `event CS2103T /from Mon 2pm /to Sun 2pm` |


### Adding an event : `deadline`
### Adding a deadline: `deadline`
Adds a deadline to remind users to do something before the due date


Expand All @@ -49,6 +49,82 @@ Format : `deadline NAME /by DD/MM/YYYY`
| `deadline CS2103T IP /by 13/09/2023` |


### List all tasks : `list`
Shows user all the current tasks both pending and completed as long as it is not removed / deleted


Format : `list`

| Examples |
| --- |
| `list` |


### Mark as Done : `mark`
Marks a specific task / deadline / event as completed with a tick


Format : `mark INDEX` where INDEX is the current position of the activity users want to mark as done
- The `INDEX` must be a positive integer 1,2,3 where 1 is the first task appearing in the list

| Examples |
| --- |
| `mark 1` |
| `mark 2` |


### Delete a Specific Job / Task : `delete`
Deletes the specified job / task from the task list


Format : `delete INDEX` where INDEX is the current position of the activity users want to delete
- The `INDEX` must be a positive integer 1,2,3 where 1 is the first task appearing in the list

| Examples |
| --- |
| `delete 1` |
| `delete 2` |


### Bulk Delete : `remove`
Mass Removal of Activities that contain a certain word


Format : `remove KEYWORD` where KEYWORD is all the activities that contain that specific keyword
- The `KEYWORD` is case-sensitive
- The order of the word matters
- Partial words will be matched

| Examples |
| --- |
| `remove CS2103T` |
| `remove playing` |


### Navigate to Specific Activty : `find`
Finds tasks / activities whose naming contain of the given keywords


Format : `find KEYWORD` where KEYWORD is all the activities that contain that specific keyword
- The `KEYWORD` is case-sensitive
- The order of the word matters
- Partial words will be matched

| Examples |
| --- |
| `find CS2103T` |
| `find playing` |


### Exiting the Duke : `bye`
Exit the program and saves the current entry

Format : `bye`

| Examples |
| --- |
| `bye` |

___


Expand Down

0 comments on commit aef2b93

Please sign in to comment.