Update README.md

Author: Hzxin

README.md

@@ -1,23 +1,188 @@
-# duke project template
-
-This is a project template for a greenfield Java project. It's named after the Java mascot _Duke_. Given below are instructions on how to use it.
-
-## Setting up in Intellij
-
-Prerequisites: JDK 11, update Intellij to the most recent version.
-
-1. Open Intellij (if you are not in the welcome screen, click `File` > `Close Project` to close the existing project first)
-1. Open the project into Intellij as follows:
-   1. Click `Open`.
-   1. Select the project directory, and click `OK`.
-   1. If there are any further prompts, accept the defaults.
-1. Configure the project to use **JDK 11** (not other versions) as explained in [here](https://www.jetbrains.com/help/idea/sdk.html#set-up-jdk).
-1. After that, locate the `src/main/java/duke.java` file, right-click it, and choose `Run duke.main()`. If the setup is correct, you should see something like the below:
-   ```
-   Hello from
-    ____        _        
-   |  _ \ _   _| | _____ 
-   | | | | | | | |/ / _ \
-   | |_| | |_| |   <  __/
-   |____/ \__,_|_|\_\___|
-   ```
+# Duke User Guide 
+
+<p align="center">
+    <img src="./Ui.png" width="400" heigh = "600">
+</p>
+
+## Features 
+
+Duke is a task tracking applications that helps you to keep track of task/events with or without deadline.
+
+## Usage
+
+### Build and Run
+
+To use Duke, you have to compile and run Duke.java at `src/main/java/duke`.
+
+An alternatives will be using gradle to build and run the application.
+
+A packaged jar file has been attached in the latest release. Feel free to download it.
+To run the jar file, simply type in the command `java -jar Duke.jar` 
+
+
+### 1. `todo` - Add a todo task
+
+Add a todo task with your given task content to Duke.
+
+Format: `todo CONTENT`
+
+Example:
+```$xslt
+todo a 2103 individual project
+```
+
+Expected Outcome:
+```$xslt
+Added liao: [T][ ] 1. a 2103 individual project
+You have 1 task in the list!
+```
+### 2. `deadline` - Add a deadline task
+
+Add a deadline task with your given task content and deadline(YYYY-MM-DD) to Duke.
+
+Format: `deadline CONTENT/DEADLINE`
+
+Example:
+```$xslt
+deadline team meeting/2021-01-22
+```
+
+Expected Outcome:
+```$xslt
+Added liao: [D][ ] 2. team meeting (Jan 22 2021)
+You have 2 tasks in the list!
+```
+
+### 3. `event` - Add an event
+
+Add an event with the event content and deadline(YYYY-MM-DD) to Duke.
+
+Format: `event CONTENT/DEADLINE`
+
+Example:
+```$xslt
+event Chinese New Year/2021-02-11
+```
+
+Expected Outcome:
+```$xslt
+Added liao: [E][ ] 3. Chinese New Year (Feb 11 2021)
+You have 3 tasks in the list!
+```
+
+### 4. `list` - List all the current tasks
+
+List all the tasks that you have added to Duke.
+
+Format: `list`
+
+Example:
+```$xslt
+list
+```
+
+Expected Outcome:
+```$xslt
+[T][ ] 1. a 2103 individual project
+[D][ ] 2. team meeting (Jan 22 2021)
+[E][ ] 3. Chinese New Year (Feb 11 2021)
+```
+
+### 5. `done` - Mark a current task as done.
+
+Mark a current task with the given index as done in Duke.
+
+Format: `done INDEX`
+
+Example:
+```$xslt
+done 1
+
+list
+```
+
+Expected Outcome:
+```$xslt
+Wah~ You done the task: [T][X] 1. a 2103 indivual project
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+[T][X] 1. a 2103 individual project
+[D][ ] 2. team meeting (Jan 22 2021)
+[E][ ] 3. Chinese New Year (Feb 11 2021)
+```
+
+### 6. `delete` - Delete a current task from Duke.
+
+Delete a task with the given index in Duke.
+
+Format: `delete INDEX`
+
+Example:
+```$xslt
+delete 1
+kust
+```
+
+Expected Outcome:
+```$xslt
+Awww~ You've deleted the task: [T][X] 1. a 2103 indiviual project
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+[D][ ] 1. team meeting (Jan 22 2021)
+[E][ ] 2. Chinese New Year (Feb 11 2021)
+```
+
+### 7. `find` - Find all relevant tasks.
+
+Find all relevent tasks with your given keyword in Duke.
+
+Format: `find KEYWORD`
+
+Example:
+```$xslt
+find meeting
+```
+
+Expected Outcome:
+```$xslt
+Here are the matches for your search:
+[D][ ] 1. team meeting (Jan 22 2021)
+```
+
+### 8. `clear` - Clear statistics and history.
+
+Delete user history file.
+
+Format: `clear`
+
+Example:
+```$xslt
+clear
+```
+
+Expected Outcome:
+```$xslt
+Successfully clear statistics
+(Statistics.txt removed)
+```
+
+### 9. `bye` - exit Duke
+
+Exit Duke and save your task history.
+
+Format: `bye`
+
+Example:
+```$xslt
+bye
+```
+
+Expected Outcome: Application Exits
+
+
+## Author
+Huang Zhenxin
+
+
+
+
+
+