Add user guide

docs/README.md

@@ -1,20 +1,83 @@
-# User Guide
+# Bari user guide
+
+**Bari** is a simple chatbot that can keep track of tasks for you.
+Enter a command and your task list will be updated automatically – less fuss than
+using some other application for a notepad and having to manually update each and
+every aspect of the tasks as they come and are done.
+
+The name is that of an Italian city, known for its pasta, its Adriatic coast and
+Saint Nicholas. 
+
+![Screenshot of Bari](Ui.png)
 
 ## Features 
 
-### Feature 1 
-Description of feature.
+* Minimalistic user interface
+* Support for to-dos, events and deadlines
+* Support for finding and sorting tasks
+* Auto-saving of tasks after each command
+* Export and import of tasks, saved in `tasks.txt` in the same folder
+as the application
+
+## Commands
+
+`todo [description]`  
+`event [description] /at [time]`  
+`deadline [description] /by [time]`
+
+Add a task of the corresponding type to the task list. Bari will display
+the task you have just entered, followed by the number of tasks in the list
+after that addition.
+
+`time` is a full date and time in the format `day#/month#/yyyy hhmm`, e.g.
+`1/4/2019 1201` means 1 April 2019, 12:01. Bari will display dates in this "natural" format
+in the user interface.
+
+----
+
+`done [index]`
+
+Mark the task at the given index in the task list as done. Marking a task already done
+has no effect; in any case Bari will show you which task you just marked as done.
+
+The index of a task is between 1 and _n_ inclusive, where _n_ is the number of tasks
+in the task list. An error will be raised if the provided index is non-numeric
+or outside this range. 
+
+----
+
+`delete [index]`
+
+Delete the task at the given index in the task list. Bari will display the task that was
+just deleted, so you may enter it again if the deletion was by mistake.
+
+The permissible values of the index are the same as for the `done` command.
+
+----
+
+`list`
+
+Get Bari to list out all the tasks in your task list. This list will be preceded by the
+number of tasks and will display the corresponding index numbers beside each task.
+
+----
+
+`find [string]`
 
-## Usage
+Find which tasks contain the given string (case-sensitive) and show them. As with `list`,
+the number of matching tasks will be displayed before the list proper.
 
-### `Keyword` - Describe action
+----
 
-Describe action and its outcome.
+`sort`
 
-Example of usage: 
+Quietly sort all tasks by task type, then done status, then description.
+_Quiet_ means that Bari will only tell you that the tasks have been sorted;
+the `list` command then needs to be used to explicitly display them.
 
-`keyword (optional arguments)`
+----
 
-Expected outcome:
+`exit`
 
-`outcome`
+Exit the application. Bari is kind enough to say "Bye!" and keep the window open long
+enough for you to see that message before finally disappearing into the background.

licence

@@ -0,0 +1,9 @@
+MIT License
+
+© 2019 Jeremy Tan / Parcly Taxel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

tasks.txt

@@ -0,0 +1 @@
+D|0|zero|1/9/2019 0800