Skip to content

Commit

Permalink
Final edits
Browse files Browse the repository at this point in the history
  • Loading branch information
pkpaing committed Feb 16, 2023
1 parent 546a317 commit 9ed6fc0
Show file tree
Hide file tree
Showing 2 changed files with 145 additions and 9 deletions.
Binary file removed docs/.README.md.swp
Binary file not shown.
154 changes: 145 additions & 9 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,164 @@

## Features

### Feature-ABC
### Add task

Description of the feature.
Add a todo, deadline or event. ``` todo, deadline /by, event /from /to ```

### Feature-XYZ
### Display tasks

Description of the feature.
Display all of the tasks you have added. ``` list ```


### Mark/Unmark tasks

Toggle whether a task has been done or not. ``` mark, unmark ```

### Delete tasks

Delete a task from your list. ``` delete ```

### Sort

Display sorted tasks in your list ``` sort ```

### Find

Find specific tasks using keywords ``` find ```

## Usage

### `Keyword` - Describe action
### `todo` - adds todo

Example of usage:

Describe the action and its outcome.
`todo (description of task)`

Expected outcome:

todo is added.

```
added (new todo)
```

### `deadline` - adds deadline

Example of usage:

`keyword (optional arguments)`
`deadline (description of task) /by (dd-MM-yyyy)`

Expected outcome:

deadline is added.

```
added (new deadline)
```

### `event` - adds event

Example of usage:

`event (description of task) /from (dd-MM-yyyy HH:mm) /to (HH:mm)`

Expected outcome:

event is added.

```
added (new event)
```
### `list` - displays all tasks

Example of usage:

`list`

Expected outcome:

list of tasks are displayed.

```
1. T [X] Go home
2. T [ ] Go for a run
```

### `mark` - marks a task as done

Example of usage:

`mark (index)`

Expected outcome:

task is marked as done.

```
Nice! I've marked this task as done: (task)
```

### `unmark` - marks a task as not done

Example of usage:

`unmark (index)`

Expected outcome:

task is marked as not done.

```
OK, I've marked this task as not done yet: (task)
```

### `delete` - deletes a task from the list

Example of usage:

`delete (index)`

Expected outcome:

Description of the outcome.
task is deleted from the list.

```
expected output
Noted. I've removed this task (task).
Now you have (task number) tasks in the list
```

### `sort` - displays sorted list of tasks

Example of usage:

`sort`

Expected outcome:

sorted list of tasks is displayed.

```
1. T [X] Go home
2. T [ ] Go for a run
1. D [X] Go home (by: 23/02/2023)
```

### `find` - finds task based on keywords

Example of usage:

`find (keyword)`

Expected outcome:

list of tasks containing the keyword is displayed.

```
find work
1. T [X] Finish work
2. T [ ] Work on assignments
1. D [X] Workout (by: 23/02/2023)
```

0 comments on commit 9ed6fc0

Please sign in to comment.