Skip to content

Commit

Permalink
Add User Guide
Browse files Browse the repository at this point in the history
The previous version  doesn't contain a user guide. Let's add a user guide.
  • Loading branch information
redpelican2108 committed Feb 17, 2022
1 parent cc5a076 commit 4d3cbf3
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 14 deletions.
58 changes: 44 additions & 14 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,59 @@
# User Guide

Welcome to Narcibot, the most narcissistic bot ever created.
Narcibot allows you to track 3 different tasks, list them, find them and also save them for future use.
## Features

### Feature-ABC
### Todo
Tasks withoutany time required.
Syntax: todo [task]
Example: `todo eat`

Description of the feature.
### Deadline
Tasks to complete before a deadline.
Syntax: deadline [task] /by [time]
Example: `deadline finish maths homework /by 10pm`

### Feature-XYZ
### Event

Description of the feature.
Tasks that occur in a certain period of time.
Syntax: event [task] /at [time]
Example: `event sleep /at 12am - 8am`

## Usage
### List
List all tasks recorded.
Syntax: `list`

### `Keyword` - Describe action
### Mark
Marks a task as done from the list of tasks via the number.
Syntax: mark [number]
Example: `mark 2`

Describe the action and its outcome.
### Unmark
Marks a task as not done from the list of tasks via the number.
Syntax: unmark [number]
Example: `unmark 1`

### Delete
Deletes a task from the list of tasks via the number.
Syntax: delete [number]
Example: `delete 3`

### Update
Updates the time of an event or deadline type task. Does not work for todo tasks.
Syntax: Update [number] [time]
Example: `update 4 11pm`

### Find
Find tasks with the related keyword.
Syntax: Find [keyword]
Example: `find homework`

### Bye
Saves your current state and list of tasks.
Syntax: `bye`

Example of usage:

`keyword (optional arguments)`

Expected outcome:

Description of the outcome.

```
expected output
```
Binary file added docs/Ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4d3cbf3

Please sign in to comment.