diff --git a/docs/README.md b/docs/README.md index 1bfcb5abb..8eef07990 100644 --- a/docs/README.md +++ b/docs/README.md @@ -13,13 +13,73 @@ MudMud is a chatbot application for creating and managing tasks with the use of 7. Run the app again and the app is ready to use! ## Features -* Veiwing your current tasks: `list` -* Adding a todo task: `todo` -* Adding a deadline task: `deadline` -* Adding an event task: `event` -* Marking a task: `mark` -* Unmarking a task: `unmark` -* Delete a task: `delete` -* Searching for tasks: `find` -* Exiting the application: `bye` +* Veiwing your current tasks - `list` +* Adding a todo task - `todo` +* Adding a deadline task - `deadline` +* Adding an event task - `event` +* Marking a task - `mark` +* Unmarking a task - `unmark` +* Deleting a task - `delete` +* Searching for tasks - `find` +* Exiting the application - `bye` +## Veiwing your current tasks - `list` +List all tasks available in the app. + +## Adding a todo task - `todo` +Add a new todo task into the list with the format below: +`todo 'task'` + +**Example:** +`todo buy book` + +## * Adding a deadline task - `deadline` +Add a new deadline task into the list with the format below: +`deadline 'task' /by 'specified deadline'` + +Your `specified deadline` should be in this format: +`yyyy-MM-dd HHmm` + +**Example:** +`deadline submit homework /by 2022-10-23 2359` + +## Adding an event task - `event` +Add a new event task into the list with the format below: +`event 'task' /from 'specified start date' /to 'specified end date'` + +Your `specified start date` and `specified end date` should be in this format: +`yyyy-MM-dd HHmm` + +**Example:** +`event party /from 2022-07-10 1900 /to 2022-07-10 2100` + +## Marking a task - `mark` +Mark a task in the list with the format below: +`mark 'task number'` + +**Example:** +`mark 2` will mark the second task in the list. + +## Unmarking a task - `unmark` +Unmark a task in the list with the format below: +`unmark 'task number'` + +**Example:** +`unmark 3` will unmark the third task in the list. + +## Deleting a task - `delete` +Delete a task in the list with the format below: +`delete 'task number'` + +**Example:** +`delete 1` will delete the first task in the list. + +## Searching for tasks - `find` +Find tasks with the matching keyword in the list with the format below. +`find 'keyword'` + +**Example:** +`find book` will find tasks with the keyword `book` in the list. + +## Exiting the application - `bye` +Exits the application.