Edit README.md

Author: mechastriker3

docs/README.md

@@ -1,19 +1,24 @@
 # B.O.B Task Manager User Guide
 A todo task manager bot to record and store list of tasks.
 
+![image](../src/main/resources/images/DaDuke.png)
+
+Source: MrDestructoid (Twitch Emote) 
+
 # Features
 Below are the features currently implemented:
 
 1. [**`Add`**](#add) Adding tasks to the bot.
-   - 1.1 Todo
-   - 1.2 Event
-   - 1.3 Deadline
+   - 1.1. [**`Todo`**](#todo)
+   - 1.2. [**`Event`**](#event)
+   - 1.3. [**`Deadline`**](#deadline)
 2. [**`List`**](#list) Listing all existing tasks.
 3. [**`Marking Done`**](#done) Mark completed tasks as done.
 4. [**`Delete`**](#delete) Deleting tasks using index.
-5. [**`Storage & Retrieval`**](#storage) Storing of tasks in local drive.
-6. [**`Find`**](#find) Finding tasks based on keywords.
-7. [**`Remind`**](#remind) Remind Users about upcoming tasks.
+5. [**`Find`**](#find) Finding tasks based on keywords.
+6. [**`Remind`**](#remind) Remind Users about upcoming tasks.
+7. [**`Storage & Retrieval`**](#storage) Storing of tasks in local drive.
+
 
 ## Feature Details
 
@@ -26,7 +31,7 @@ segment his tasks into.
 - Event
 - Deadline
 
-### Todo
+### Todo<a name="todo"></a>
 Adds a todo task with **task description** into B.O.B Task Manager.
 
 **Command Syntax**
@@ -40,11 +45,16 @@ Adds a todo task with **task description** into B.O.B Task Manager.
 
 **Expected outcome:**
 
+CLI:
+
     ADDED: [TODO][X] read book
+    Current Total Tasks: 1 task
+
+GUI
 
 ![image](./images/add-todo.png)
 
-### Event
+### Event<a name="event"></a>
 Adds an event task with the **task description** and 
 **Date and Time** into B.O.B Task Manager.
 
@@ -61,11 +71,16 @@ Adds an event task with the **task description** and
 
 **Expected outcome:**
 
+CLI:
+
     ADDED: [EVENT][X] watch movie (at: Feb 14 2021, 17:00)
+    Current Total Tasks: 2 tasks
+
+GUI:
 
 ![image](./images/add-event.png)
 
-### Deadline
+### Deadline<a name="deadline"></a>
 Adds a deadline task with the **task description** and
 **Date and Time** into B.O.B Task Manager.
 
@@ -82,7 +97,12 @@ Adds a deadline task with the **task description** and
 
 **Expected outcome:**
 
+CLI:
+
     ADDED: [DEADLINE][X] return book (by: Mar 11 2021, 23:59)
+    Current Total Tasks: 3 tasks
+
+GUI:
 
 ![image](./images/add-deadline.png)
 
@@ -101,44 +121,155 @@ The user will be able to list all existing tasks in B.O.B Task Manager.
 
 **Expected outcome:**
 
+CLI:
+
     Ok Human. Here are your tasks:
         1. [TODO][X] read book
         2. [EVENT][X] watch movie (at: Feb 14 2021, 17:00)
         3. [DEADLINE][X] return book (by: Mar 11 2021, 23:59)
 
-![image](./list.png)      
+GUI:
+
+![image](./images/list.png)      
 
 ---
 
-### 4. Marking Done  <a name="done"></a>
-  
-    done <index of task>
+### Feature 3 - Marking Done  <a name="done"></a>
+Marks the completion of a task using the index of the task. 
 
-Marks the completion, indicated by a `X` or `✓`. Completed tasks will display `[✓]`.
-The index of the task corresponds to the number of which it is listed, you can simply run `list`
-to check the index of the task.
+Completion status is indicated by a `X` or `✓`.
+
+**Command Syntax**
+
+      done <index of task>
+
+Note: The index of the task corresponds to the number beside it when listed, you can simply use `list`
+to get the index of the task.
 
 **Example of usage:**
 
     done 1
 
 **Expected outcome:**
 
-    Swee la, task done liao:
-        [T][✓] eat genki sushi
+CLI:
+
+    Noted Human. I've marked this task as done:
+    [TODO][✓] read book
+
+GUI:
+
+![image](./images/done.png)
+
+### Feature 4 - Delete  <a name="delete"></a>
+Deletes a task from the list using the index of the task.
+
+**Command Syntax**
+
+      delete <index of task>
+
+Note: The index of the task corresponds to the number beside it when listed, you can simply use `list`
+to get the index of the task.
+
+**Example of usage:**
+
+    delete 1
+
+**Expected outcome:**
+
+CLI:
+
+    Task deleted successfully:
+    [TODO][✓] read book
+    Current Total Tasks: 2 tasks
+    
+
+GUI:
+
+![image](./images/delete.png)
+
+----
+
+### Feature 5 - Find  <a name="find"></a>
+Find task(s) from the list using a given keyword and lists only the relevant task(s).
+
+**Command Syntax**
+
+      find <key word(s)>
+
+
+
+**Example of usage:**
+
+    find book
+
+**Expected outcome:**
+
+CLI:
+
+    Ok Human. Here are the tasks I found:
+    1: [DEADLINE][X] return book (by: Mar 11 2021, 23:59)
+
+GUI:
+
+![image](./images/find.png)
+
+---
+
+### Feature 6 - Remind  <a name="find"></a>
+Show upcoming task(s), and optional **number of days** argument can be given to 
+specify the maximum time span (in days) for the task to be considered 'upcoming'.
+
+**Command Syntax**
+
+       remind
+or
+
+       remind <number of days>
+
+Note: If **number of days** not specified, the default time span is 3 days. 
+This can be configured in the line below in RemindCommand.java
+
+      private static final int DEFAULT_NUM_DAYS = 3;
+
+Full file path relative to root of project folder: `/src/main/java/duke/command/RemindCommand.java`
+
+
+**Example of usage:**
+
+    remind 30
+
+**Expected outcome:**
+
+CLI:
 
+    Ok Human. Here are the tasks I found:
+    1: [DEADLINE][X] return book (by: Mar 11 2021, 23:59)
 
+GUI:
 
-## Usage
+![image](./images/remind.png)
 
-### `Keyword` - Describe action
+---
 
-Describe action and its outcome.
+### Feature 7. Storage and Retrieval of Tasks  <a name="storage"></a>
+B.O.B Task Manager will attempt to retrieve stored tasks from a storage file 
+in your local computer. Upon launching, it will parse through the
+text file and populate the application with the stored data.
 
-Example of usage: 
+If there are no storage files are found, a text file named `tasks.txt` will be  
+in created in the root directory of the project. All subsequent information will
+be stored in this file.
 
-`keyword (optional arguments)`
+The default file path is set as shown below:
 
-Expected outcome:
+    private final String defaultPath = "./tasks.txt";
+
+If you would like to change the default directory or change the filename, 
+you can edit the above code in `Storage.java`. 
+
+Full file path relative to root of project folder: `/src/main/java/duke/Storage.java`
+
+---
 
-`outcome`
+# THE END

docs/images/add-deadline.png

@@ -2,13 +2,10 @@
 
 import java.io.InputStream;
 import java.io.PrintStream;
-import java.time.LocalDateTime;
 import java.util.Scanner;
 
-import duke.task.Deadline;
-import duke.task.Event;
 import duke.task.Task;
-import duke.task.ToDo;
+
 
 
 /**
@@ -55,6 +52,21 @@ public String showBye() {
         return LINE_PREFIX + EXIT_MESSAGE + "\n";
     }
 
+    /**
+     *
+      * @param taskList
+     * @return
+     */
+    public String showTasksCount(TaskList taskList) {
+        int count = taskList.getTasksCount();
+        return (count == 1)
+            ? "Current Total Tasks: " + count
+                + " task"
+            : "Current Total Tasks: " + count
+                    + " tasks";
+
+    }
+
     /**
      * Return all task in taskList as a string
      * @param taskList
@@ -129,41 +141,16 @@ public String showTaskDone(Task task) {
      * @param task
      * @return
      */
-    public String showTaskDeleted(Task task) {
-        return String.format(LINE_PREFIX + "Task deleted successfully:\n[%s] [%s] %s\n",
+    public String showTaskDeleted(Task task, TaskList taskList) {
+        return String.format(LINE_PREFIX + "Task deleted successfully:\n[%s] [%s] %s\n%s",
                 task.getTaskType(), task.getStatusIcon(),
-                task.getTaskDescription());
+                task.getTaskDescription(), showTasksCount(taskList));
     }
 
-    public String showAdd(Task task) {
-        return String.format(LINE_PREFIX + "Added:\n%s\n", task);
+    public String showAdd(Task task, TaskList taskList) {
+        return String.format(LINE_PREFIX + "Added:\n%s\n%s\n", task, showTasksCount(taskList));
     }
 
-    public String showAddToDo(ToDo toDo) {
-        return String.format(LINE_PREFIX + "Added:\n[%s] [%s] %s\n",
-                toDo.getTaskType(), toDo.getStatusIcon(),
-                toDo.getTaskDescription());
-
-    }
-
-    public String showAddDeadLine(Deadline deadline) {
-        LocalDateTime time = deadline.getEndTime();
-        return String.format(LINE_PREFIX + "Added:\n[%s] [%s] %s (by: %s %s %s %02d:%02d)\n",
-                deadline.getTaskType(), deadline.getStatusIcon(), deadline.getTaskDescription(),
-                time.getMonth(), time.getDayOfMonth(), time.getYear(), time.getHour(),
-                time.getMinute());
-    }
-
-    public String showAddEvent(Event event) {
-        LocalDateTime time = event.getEventTime();
-        return String.format(LINE_PREFIX + "Added:\n[%s] [%s] %s (at: %s %s %s %02d:%02d)\n",
-                event.getTaskType(), event.getStatusIcon(), event.getTaskDescription(),
-                time.getMonth(), time.getDayOfMonth(), time.getYear(), time.getHour(),
-                time.getMinute());
-    }
-
-
-
     public String showError(String errorMsg) {
         return "[ERROR] : " + errorMsg + "\n";
     }