From aef2b93722e3c35ec71cd1639a1a83d801437472 Mon Sep 17 00:00:00 2001 From: MadeEasy <60029664+Vanessamae23@users.noreply.github.com> Date: Wed, 13 Sep 2023 09:51:11 +0800 Subject: [PATCH] Update README.md --- docs/README.md | 78 +++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 77 insertions(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 6fd24cbec7..f2ec7361ad 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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 @@ -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` | + ___