Skip to content

Commit

Permalink
Merge pull request #7 from rexong/A-UserGuide
Browse files Browse the repository at this point in the history
Update Readme.md
  • Loading branch information
rexong authored Sep 13, 2022
2 parents 06662d8 + 700ee49 commit d82eaef
Show file tree
Hide file tree
Showing 2 changed files with 64 additions and 15 deletions.
79 changes: 64 additions & 15 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,78 @@
# User Guide
# ShelBot

Introducing ShelBot. It is a task reminder application used by geniuses. Given below are instructions on how to use it.

## Setting up the Application

Prerequisites: JDK 11.

You can download the executable file [here](https://github.com/rexong/ip/releases/tag/A-FullCommitMessage).

## What can you expect form ShelBot?

ShelBot can help you remember all the tasks you need to remember so that you can spend more time on your work. It's
- Text Based
- Easy to Use
- Easy to Learn

**However, do note that wrong commands and unmarking tasks may lead to ShelBot YELLING at you!**

ENJOY!

```
____ ____ ______
..'''' | | | | | ~. .~ ~. `````|`````
.'' |_________| |______ | |____.'_ | | |
..' | | | | | ~. | | |
....'' | | |___________ |_______ |_______.' `.______.' |

```
## Features
1. Add Task
2. Delete Task
3. Find Task
4. List all Tasks
5. Mark Task
6. Unmark Task
### Add Task
You can use any of the 3 commands to add task
- todo
- deadline
- event
### Feature-ABC
Example:
- `todo read book`
- `deadline return book /by 30/09/2022 1800`
- `event project meeting /at 17/09/2022 1800`
Description of the feature.
### Feature-XYZ
### Delete Task
You can delete any task by specifying their index.
Description of the feature.
Example:
- `delete 1`
## Usage
### Find Task
You can find task by using some keywords
### `Keyword` - Describe action
Example:
- `find book`
Describe the action and its outcome.
### List all Task
You can list all the task available.
Example of usage:
Example:
- `list`
`keyword (optional arguments)`
### Mark Task
You can mark task that are done by specifying the index.
Expected outcome:
Example:
- `mark 1`
Description of the outcome.
### Unmark Task
You can unmark task that are done by specifying the index.
```
expected output
```
Example:
- `unmark 1`
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 d82eaef

Please sign in to comment.