Skip to content

Commit 81b67ec

Browse files
authored
Update README.md
1 parent ac59ede commit 81b67ec

1 file changed

Lines changed: 51 additions & 9 deletions

File tree

docs/README.md

Lines changed: 51 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,62 @@
11
# User Guide
22

3-
## Features
3+
## Features
44

5-
### Feature 1
6-
Description of feature.
5+
### Add tasks
6+
7+
You can add tasks of type **Todo** (which only has a description) **Deadline** (with a single date-time group as the deadline), or **Event** (with two date-time groups as the start/end instants respectively), using the `todo`, `deadline`, and `event` commands respectively.
8+
9+
### List tasks
10+
11+
You can list tasks using the command `list`.
12+
13+
### Delete tasks
14+
15+
You can delete previously-added tasks using the `delete` command.
16+
17+
### Find task
18+
19+
You can find tasks using keywords, with the `find` command.
20+
21+
### File output
22+
23+
The task file is saved as a `.csv` for easy viewing in <kbd>Microsoft Excel</kbd> and other spreadsheet programs.
724

825
## Usage
926

10-
### `Keyword` - Describe action
27+
### `todo <what is to be done>` — Creates a To-Do
28+
29+
Creates a To-Do, set by default as incomplete.
30+
31+
### `deadline <what is due> </by | /at> <due date/time>` — Creates a Deadline
32+
33+
Creates a Deadline, set by default as incomplete, with the due date/time as given. _Some_ natural date-time groups are accepted (but some are still buggy):
34+
35+
- `24th Feb 2020`
36+
- `Monday 5 pm` (buggy, as this goes to the *current* week's Monday, and not the next)
37+
- `11:40`, or `4:20pm`, or `12am SGT`
38+
- `11/2/2020` or `22/7/2020` or even `14-3-2020` (European format: `dd/MM/uuuu`)
39+
- `tomorrow` is not legit.
40+
41+
> Example use:
42+
>
43+
> - `deadline return book /by 7 pm`
44+
> - `deadline complete CS2103T iP /by Tuesday 18/2/2020 23:59`
45+
46+
### `event <event name> /from <start instant> /to <end instant>` — Creates an Event from `start instant` to `end instant`
47+
48+
As for Deadlines, natural dates/times are accepted, and the same bugs apply.
49+
50+
### `list`
51+
52+
Lists all the tasks.
1153

12-
Describe action and its outcome.
54+
### `find <keyword>` — Finds tasks
1355

14-
Example of usage:
56+
Finds all tasks that have a detail which contain `keyword`.
1557

16-
`keyword (optional arguments)`
58+
> Example of usage: `find book`
1759
18-
Expected outcome:
60+
### `delete <task number>`
1961

20-
`outcome`
62+
Deletes the task at the given `number`.

0 commit comments

Comments
 (0)