diff --git a/docs/README.md b/docs/README.md index fd44069597..7bda6e77a5 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,19 +2,96 @@ ## Features -### Feature 1 -Description of feature. +### Feature 1 +Keep track of daily tasks: to-dos, deadlines and events. + +### Feature 2 +Search for repeating keywords in tasks. ## Usage -### `Keyword` - Describe action +### `help` - Provides a list of possible Duke commands. + +Displays a list of possible Duke commands that the user can +input into Duke. + +Example of usage: + +`help` + +Expected outcome: + +`Type one of the following commands: todo ...` + +### `todo` - Adds a todo task to the user list. + +Adds a todo task to the user list. + +Example of usage: + +`todo (taskName)` + +Expected outcome: + +`Got it. I've added this task...` + +### `deadline` - Adds a deadline task to the user list. + +Adds a deadline task to the user list. + +Example of usage: + +`deadline (taskName) / (deadlineDate) (deadlineTime)` + +Expected outcome: + +`Got it. I've added this task...` + +### `event` - Adds a event task to the user list. -Describe action and its outcome. +Adds a event task to the user list. Example of usage: -`keyword (optional arguments)` +`event (taskName) / (eventDate) (eventTime)` Expected outcome: -`outcome` +`Got it. I've added this task...` + +### `list` - Lists everything in the user task list. + +Lists everything in the user task list. + +Example of usage: + +`list` + +Expected outcome: + +`Here are the tasks in your list...` + +### `find` - Finds all tasks in the user list with the matching keyword. + +Finds all tasks in the user list with the matching keyword. + +Example of usage: + +`find (keyword)` + +Expected outcome: + +`Here are the matching tasks in your list...` + +### `delete` - Deletes the task in the list with the same index. + +Deletes the task in the list with the same index. + +Example of usage: + +`delete (taskNumber)` + +Expected outcome: + +`Got it. I've deleted...` +