[rozaliesmit] iP

data/daisy.txt

@@ -0,0 +1,10 @@
+D | 0 | ip | midnight
+E | 0 | birthday | monday | tuesday
+E | 0 | holiday | today. | tomorrow
+T | 0 | sleep
+D | 0 | assignment 1 | august 5
+D | 0 | project1 | friday 23:59
+E | 0 | conference | monday 1PM | monday 7PM
+T | 0 | dream
+T | 0 | gardening
+D | 0 | dance | tomorrow

docs/README.md

@@ -1,30 +1,150 @@
-# Duke User Guide
+# Daisy 🌼User Guide
 
-// Update the title above to match the actual product name
+Hello! I'm Daisy 🌼 a flowery chatbot eager to help you bloom into a more organized and productive you! From tracking tasks to keeping you on top of your game, I'm here to make your life a little more fragrant and a lot more colourful. Let's get started!
 
-// Product screenshot goes here
+## Help: shows command formats
 
-// Product intro goes here
+Displays all possible commands and their correct format
 
-## Adding deadlines
+Format: `help`
+Example: `help`
+Example output:
 
-// Describe the action and its outcome.
+```
+Of course, I'm happy to help! Here's all the available commands:
+  list - Show all tasks
+  todo [task] - Add a to-do
+  deadline [task] /by [date] - Add a deadline
+  event [task] /from [start] /to [end] - Add an event
+  mark [index] - Mark task as done
+  unmark [index] - Unmark task
+  delete [index] - Delete task
+  find [keyword] - Find task
+  bye - Exit program
+```
+
+## List: shows all tasks
+
+Displays all tasks currently in the list
+
+Format: `help`
+Example: `list`
+Example output:
+
+```
+1. [D] [ ] ip (by: midnight)
+2. [E] [ ] birthday (from: monday to: tuesday)
+3. [T] [ ] sleep
+4. [E] [X] wedding (from: 6 to: 7)
+5. [D] [ ] assignment 1 (by: august 5)
+```
+
+## Todo: adding a to-do task
+
+Adds a to-do task to the list
+
+Format: `todo [task]`
+Example: `todo laundry`
+Example output:
+
+```
+Woww that sounds delightful! I will add:: [T] [ ] laundry
+```
 
-// Give examples of usage
+## Deadline: adding a deadline
 
-Example: `keyword (optional arguments)`
+Adds a deadline task to the list
 
-// A description of the expected outcome goes here
+Format: `deadline [task] /by [date]`
+Example: `deadline project1 /by friday 23:59`
+
+Example output:
+
+```
+Woww that sounds delightful! I will add:: [D] [ ] project1 (by: friday 23:59)
+```
+
+## Event: adding an event
+
+Adds an event task to the list
+
+Format: `event [task] /from [start] /to [end]`
+Example: `event conference /from monday 1PM /to monday 7PM`
+
+Example output:
 
 ```
-expected output
+Woww that sounds delightful! I will add:: [E] [ ] conference (from: monday 1PM to: monday 7PM)
 ```
 
-## Feature ABC
+## Mark: marking a task as done
+
+Marks a task as done
+
+Format: `mark [index]`
+Example: `mark 5`
+
+Example output:
+
+```
+Well done! I've marked this task as done: [E] [X] wedding (from: 6 to: 7)
+```
 
-// Feature details
+## Unmark: unmarking a task as done
+
+Unmarks a task, if a task turns out to be incomplete
+
+Format: `unmark [index]`
+Example: `unmark 5`
+
+Example output:
+
+```
+Uhoh are we getting ahead of ourselves? I've unmarked: [E] [] wedding (from: 6 to: 7)
+```
+
+## Delete: delete a task
+
+Deletes a task from the list
+
+Format: `delete [index]`
+Example: `delete 5`
+
+Example output:
+
+```
+Let's remove this: [E] [ ] wedding (from: 6 to: 7)
+```
+
+## find: find a task
+
+Searches for tasks that have a given keyword in their description
+
+Format: `find [keyword]`
+Example: `find day`
+
+Example output:
+
+```
+I see colours everywhere! Here are the matching tasks in your list:
+1. [E] [ ] birthday (from: monday to: tuesday)
+2. [E] [ ] holiday (from: today. to: tomorrow)
+```
+
+## bye: exit program
+
+Closes the program
+
+Format: `bye`
+Example: `bye`
+
+Example output:
+
+```
+ Byebye! I'll be photosynthesizing in the corner but I hope to see you bloom again soon! 🌸
+```
 
+## save and store data
 
-## Feature XYZ
+Tasks are saved automatically after any changes to the list. It is saved as a text file in `[JAR file location]/data/daisy.txt`.
 
-// Feature details