Add user guide

data/duke.txt

@@ -1,7 +1,3 @@
-E | N | Finals | 2023-11-11 | 2023-11-12
-T | Y | read book
-T | N | return book
-D | N | write book | 2023-10-10
-E | N | book fair | 2023-11-10 | 2023-11-11
-T | Y | buy pants
-D | N | project submission | 2023-11-10
+D | N | return book | 2020-09-20
+E | N | fun carnival | 2023-11-08 | 2020-09-21
+T | N | read book

docs/README.md

@@ -1,29 +1,219 @@
-# User Guide
+# KS Task Manager User Guide
 
 ## Features 
 
-### Feature-ABC
+### Adding tasks
 
-Description of the feature.
+You can add 3 types of tasks: ToDos, Deadlines and Events.
 
-### Feature-XYZ
+### Marking tasks
 
-Description of the feature.
+You can mark tasks as complete or incomplete.
+
+### Finding tasks
+
+You can find tasks by searching for a keyword.
+
+### Updating and deleting tasks
+
+You can update or delete tasks if you made a mistake.
 
 ## Usage
 
-### `Keyword` - Describe action
+### Adding a ToDo - `todo` 
+
+Adds a ToDo task to the task list.
+
+Format: `todo <description>`
+
+Example of usage:
+
+`todo read book`
+
+Expected outcome:
+
+A message indicating that the task has been added and the number of tasks in the list.
+
+```
+Got it. I've added this task:
+[T][ ] read book
+Number of tasks: 1
+```
+### Adding a Deadline - `deadline`
+
+Adds a Deadline task to the task list.
+
+Format: `deadline <description> /by <YYYY-MM-DD>`
+
+Example of usage:
+
+`deadline return book /by 2020-09-20`
+
+Expected outcome:
+
+A message indicating that the task has been added and the number of tasks in the list.
+
+```
+Got it. I've added this task:
+[D][ ] return book (by: 20-Sep-2020)
+Number of tasks: 2
+```
+### Adding an Event - `event`
+
+Adds an Event task to the task list.
+
+Format: `event <description> /from <YYYY-MM-DD> /to <YYYY-MM-DD>`
+
+Example of usage:
+
+`event carnival /from 2020-09-20 /to 2020-09-21`
+
+Expected outcome:
+
+A message indicating that the task has been added and the number of tasks in the list.
+
+```
+Got it. I've added this task:
+[E][ ] carnival (from: 20-Sep-2020 to: 21-Sep-2020)
+Number of tasks: 3
+```
+### Listing all tasks - `list`
+
+Lists all tasks in the task list.
+
+Format: `list`
+
+Example of usage:
+
+`list`
+
+Expected outcome:
+
+Shows all tasks in the task list.
+
+```
+Here are the tasks in your list:
+    1.[T][ ] read book
+    2.[D][ ] return book (by: 20-Sep-2020)
+    3.[E][ ] carnival (from: 20-Sep-2020 to: 21-Sep-2020)
+```
+### Marking a task as done - `mark`
+
+Marks a task as done.
+
+Format: `mark <task index>`
+
+Example of usage:
+
+`mark 1`
+
+Expected outcome:
+
+A message indicating that the task has been marked as done.
 
-Describe the action and its outcome.
+```
+Nice! I've marked this task as done:
+[T][X] read book
+```
+### Marking a task as not done - `unmark`
 
-Example of usage: 
+Marks a task as not done.
 
-`keyword (optional arguments)`
+Format: `unmark <task index>`
+
+Example of usage:
+
+`unmark 1`
 
 Expected outcome:
 
-Description of the outcome.
+A message indicating that the task has been marked as not done.
+
+```
+OK, I've marked this task as not done yet:
+[T][ ] read book
+```
+### Deleting a task - `delete`
+
+Deletes a task from the task list.
+
+Format: `delete <task index>`
+
+Example of usage:
+
+`delete 1`
+
+Expected outcome:
+
+A message indicating that the task has been deleted and the number of tasks in the list.
+
+```
+Noted. I've removed this task:
+[T][ ] read book
+Number of tasks: 2
+```
+### Finding tasks - `find`
+
+Find tasks by searching for a keyword.
+
+Format: `find <keyword>`
+
+Example of usage:
+
+`find book`
+
+Expected outcome:
 
+Shows all tasks that contain the keyword.
 ```
-expected output
+Here are the matching tasks in your list:
+    1.[D][ ] return book (by: 20-Sep-2020)
+    2.[T][ ] read book
+```
+### Updating tasks - `update`
+
+Updates a task in the task list.
+
+Format: 
+
+`update <task index> /desc <description>`
+
+`update <task index> /by <YYYY-MM-DD>`
+
+`update <task index> /from <YYYY-MM-DD>`
+
+`update <task index> /to <YYYY-MM-DD>`
+
+Example of usage:
+
+`update 2 /from 2023-11-08`
+
+`update 2 /desc fun carnival`
+
+Expected outcome:
+
+Updates the task and shows the updated task.
+```
+OK, I've updated this task:
+[E][ ] carnival (from: 8-Nov-2023 to: 21-Sep-2020)
+```
+```
+OK, I've updated this task:
+[E][ ] fun carnival (from: 8-Nov-2023 to: 21-Sep-2020)
+```
+### Ending the program - `bye`
+
+Ends the program.
+
+Format: `bye`
+
+Example of usage:
+
+`bye`
+
+Expected outcome:
+
+Shows a goodbye message and ends the program.
 ```
+Bye. Hope to see you again soon!
+```

src/main/java/duke/Main.java

@@ -21,7 +21,7 @@ public class Main extends Application {
      */
     @Override
     public void start(Stage stage) {
-        stage.setTitle("Task Manager");
+        stage.setTitle("KS Task Manager");
         stage.show();
         try {
             FXMLLoader fxmlLoader = new FXMLLoader(Main.class.getResource("/view/MainWindow.fxml"));

src/main/java/duke/MainWindow.java

@@ -10,7 +10,7 @@
  * Controller for MainWindow. Provides the layout for the other controls.
  */
 public class MainWindow extends AnchorPane {
-    static final String INITIAL_RESPONSE = "Hello, I'm your task manager :)\nWhat can I do for you?";
+    static final String INITIAL_RESPONSE = "Hello, I'm KS task manager :)\nWhat can I do for you?";
     static final String FINAL_RESPONSE = "Bye. Hope to see you again soon!";
     @FXML
     private ScrollPane scrollPane;

src/main/java/duke/Ui.java

@@ -12,7 +12,7 @@ public class Ui {
      * Displays a greeting message to the user.
      */
     public static void greet() {
-        System.out.println(LINE + "\nHello, I'm your task manager :)\nWhat can I do for you?\n" + LINE);
+        System.out.println(LINE + "\nHello, I'm KS task manager :)\nWhat can I do for you?\n" + LINE);
     }
 
     /**