A-UserGuide done

sreesubbash · Sep 17, 2019 · b18dc86 · b18dc86
1 parent b8fed1c
commit b18dc86
Show file tree

Hide file tree

Showing 6 changed files with 91 additions and 70 deletions.
diff --git a/.gradle/5.5.1/executionHistory/executionHistory.lock b/.gradle/5.5.1/executionHistory/executionHistory.lock
diff --git a/.gradle/5.5.1/fileHashes/fileHashes.lock b/.gradle/5.5.1/fileHashes/fileHashes.lock
diff --git a/.gradle/buildOutputCleanup/buildOutputCleanup.lock b/.gradle/buildOutputCleanup/buildOutputCleanup.lock
diff --git a/.idea/workspace.xml b/.idea/workspace.xml
diff --git a/docs/README.md b/docs/README.md
@@ -1,20 +1,27 @@
-# User Guide
+# User Guide of DUKE
 
-## Features 
 
-### Feature 1 
-Description of feature.
+### Your personal assistant
+Welcome to Duke! Here you can save todos, events and deadlines.
+
+![Image of Duke](Ui.PNG)
+
+## Features 
 
 ## Usage
 
-### `Keyword` - Describe action
+### `list` - Lists out the top 4 tasks
+
+### `todo  <my task>` - Adds a todo into your list
+
+### `deadline  <my task> /by <DD/MM/YYYY HHmm>` - Adds a deadline into your list
 
-Describe action and its outcome.
+### `event  <my task> /at <DD/MM/YYYY HHmm>` - Adds an event into your list
 
-Example of usage: 
+### `find  <search>` - Gets tasks that match the search 
 
-`keyword (optional arguments)`
+### `done  <task number>` - Checks task as done
 
-Expected outcome:
+### `duplicates` - Lists all the possible duplicate values.
 
-`outcome`
+### `bye` - Exit application
diff --git a/docs/Ui.PNG b/docs/Ui.PNG