finished README

docs/README.md

@@ -1,121 +1,116 @@
 # Doot User Guide
-// Product intro goes here
 Doot - a minimal CLI task manager application. Allows storage of todos, events, and deadlines. Also allows the user to
 mark, unmark, search, and delete tasks.
 
 
 ## Adding deadlines
 
-// Describe the action and its outcome.
+Adds a deadline to the application. Must include the keyword "deadline" followed by the task, followed by "/by" followed
+by the deadline date.
 
-// Give examples of usage
-
-Example: `keyword (optional arguments)`
+Example: `deadline run /by 2024-07-29`
 
-// A description of the expected outcome goes here
+Prints a message saying that the deadline was successfully added.
 
 ```
-expected output
+added: [D][ ] watch tv (by: 2024-07-29)
 ```
 
 ## Adding todo
 
-// Describe the action and its outcome.
-
-// Give examples of usage
+Adds a todo task to the application. Must include the keyword "todo" followed by a description of the task.
 
-Example: `keyword (optional arguments)`
+Example: `todo read`
 
-// A description of the expected outcome goes here
+Prints a message saying that the todo was successfully added.
 
 ```
-expected output
+added: [T][ ] read
 ```
 
 ## Adding events
 
-// Describe the action and its outcome.
+Adds an event task to the application. Must include the keyword "event" followed by a description of the event, followed
+by "/from" followed by the start date of the event, followed by "/to" followed by the end date of the event.
 
 // Give examples of usage
 
-Example: `keyword (optional arguments)`
+Example: `event play /from today /to tomorrow`
 
-// A description of the expected outcome goes here
+Prints a message saying that the event was successfully added.
 
 ```
-expected output
+added: [E][ ] play (from: today to: tomorrow)
 ```
 
 
 ## Removing a task
 
-// Describe the action and its outcome.
+Removes the specified task from the application. Must include the keyword "delete" followed by the index of the task
+to be removed.
 
-// Give examples of usage
-
-Example: `keyword (optional arguments)`
+Example: `delete 1`
 
-// A description of the expected outcome goes here
+Prints a message saying which task was deleted.
 
 ```
-expected output
+Noted. I've removed this task: 
+[T][ ] read book
+Now you have 2 tasks in this list.
 ```
 
 
 ## Marking a task
 
-// Describe the action and its outcome.
+Marks a task in the application as done. Must include they keyword "mark" followed by the index of the task to mark.
 
-// Give examples of usage
+Example: `mark 1`
 
-Example: `keyword (optional arguments)`
-
-// A description of the expected outcome goes here
+Prints a message saying which task was marked.
 
 ```
-expected output
+OK, I've marked this task as done: read
 ```
 
 
 ## Unmarking a task
 
-// Describe the action and its outcome.
-
-// Give examples of usage
+Unmarks a task in the application as done. Must include they keyword "unmark" followed by the index of the task to mark.
 
-Example: `keyword (optional arguments)`
+Example: `unmark 1`
 
-// A description of the expected outcome goes here
+Prints a message saying which task was unmarked.
 
 ```
-expected output
+OK, I've marked this task as not done yet: read
 ```
 
-## Listing tasks
 
-// Describe the action and its outcome.
+## Listing tasks
 
-// Give examples of usage
+Prints a list of the tasks currently stored in the application. Must include the keyword "list".
 
-Example: `keyword (optional arguments)`
+Example: `list`
 
-// A description of the expected outcome goes here
+Prints all the tasks in the list.
 
 ```
-expected output
+Here are the tasks in your list:
+1. [T][ ] read book
 ```
 
 
 ## Finding tasks
 
-// Describe the action and its outcome.
+Finds all tasks in the application containing the search term. Must include the keyword "find" followed by the search
+term.
 
 // Give examples of usage
 
-Example: `keyword (optional arguments)`
+Example: `find read`
 
-// A description of the expected outcome goes here
+Prints all tasks containing the keyword.
 
 ```
-expected output
+1. [T][ ] read
 ```