[bljhty] iP

.gitignore

@@ -15,3 +15,4 @@ bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+*.class

docs/README.md

@@ -1,29 +1,108 @@
-# User Guide
+# DOM User Guide
+Dom is a desktop program to store a list of tasks for the user via a Command Line Interface(CLI)
+
+## Quick Start
+1. Ensure that you have JAVA '11' or above installed in your computer.
+2. Download the latest 'ip.jar' from [here](https://github.com/bljhty/ip/releases)
+3. Copy downloaded 'ip.jar' file to the desired home folder of your choice
+4. open a command terminal and 'cd' to the folder mentioned in ster 3
+5. type in the following to run the application
+
+```
+java -jar ip.jar
+```
+
+6. if successful, the following greeting should appear:
+```
+Hello from
+  ____                  
+ |  _ \  ___  _ __ ___  
+ | | | |/ _ \| '_ ` _ \ 
+ | |_| | (_) | | | | | |
+ |____/ \___/|_| |_| |_|
+
+____________________________________________________________
+Hello! I'm Dom
+What can I do for you?
+```
+7. Type in desired command to start using the program.
 
 ## Features 
+### Adding a todo task: `todo`
+Adds a task of type todo to the list.
+<br>Todo contains a description.
 
-### Feature-ABC
+Format: `todo DESCRIPTION`
+<br>Example: `todo read book`
 
-Description of the feature.
+### Adding an event: `event`
+Adds a task of type event to the list.
+<br>Event contains a description, from and to.
 
-### Feature-XYZ
+Format: `event DESCRIPTION /from FROM /to TO`
+<br>Example: `event CS2113 tutorial /from 4 April 2023 4pm /to 6pm`
 
-Description of the feature.
 
-## Usage
+### Adding a deadline: `deadline`
+Adds a task deadline to the list.
+<br>Deadline contains description and by.
 
-### `Keyword` - Describe action
+Format: `deadline DESCRIPTION /by BY`
+<br>Example: `deadline CS2113 iP /by 3 March 11.59pm`
 
-Describe the action and its outcome.
+### Viewing full list of tasks: `list`
+Shows a list of all tasks recorded in the list.
 
-Example of usage: 
+Format: `list`
 
-`keyword (optional arguments)`
+### Mark task as done: `mark`
+Marks task as done based on the task number indicated.
 
-Expected outcome:
+Format: `mark TASK_NUMBER`
+- TASK_NUMBER must be an integer that is within the list size
 
-Description of the outcome.
+Example: `mark 2`
 
-```
-expected output
-```
+### Mark task as not done: `unmark`
+Marks task as not done based on the task number indicated.
+
+Format: `unmark TASK_NUMBER`
+- TASK_NUMBER must be an integer that is within the list size
+
+Example: `unmark 3`
+
+### Delete task: `delete`
+Deletes the task based on the task number indicated.
+
+Format: `delete TASK_NUMBER`
+- TASK_NUMBER must be an integer that is within the list size
+
+Example: `delete 1`
+
+### Find task(s): `find`
+Searches the tasks in the list, returning the tasks containing the keyword in their description.
+
+Format: `find KEYWORD`
+<br>Example: `find CS2113`
+
+### Exiting DOM: `bye`
+Exits and closes the program.
+
+Format: `bye`
+
+## FAQ
+**Q**: Can I edit the file manually from the save.txt file?
+<br>**A**: It is not advised to do so, as formatting of the save.txt file incorrectly will cause the program to crash.
+
+## Command Summary
+| **Command** | **Format, Examples**                                                                                 |
+|-------------|------------------------------------------------------------------------------------------------------|
+| todo        | `todo DESCRIPTION`<br>e.g. `todo read book`                                                          |
+| event       | `event DESCRIPTION /from FROM /to TO`<br>e.g. `event CS2113 tutorial /from 4 April 2023 4pm /to 6pm` |
+| deadline    | `deadline DESCRIPTION /by BY`<br>e.g. `deadline CS2113 iP /by 3 March 11.59pm`                       |
+| list        | `list`                                                                                               |
+| mark        | `mark TASK_NUMBER`<br>e.g. `mark 2`                                                                  |
+| unmark      | `unmark TASK_NUMBER`<br>e.g. `unmark 3`                                                              |
+| delete      | `delete TASK_NUMBER`<br>e.g. `delete 1`                                                              |
+| find        | `find KEYWORD`<br>e.g. `find CS2113`                                                                 |
+| bye         | `bye`                                                                                                |