Skip to content

Commit

Permalink
Correct formatting errors in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ken-ruster committed Oct 3, 2023
1 parent b4b2c3c commit 6f33548
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,17 @@ Axel is a chatbot designed to help the user in managing tasks, for use in the CL

### *Adding a task:* `todo`, `deadline` and `event`
Adds a `Task` to the list.

Format: `todo/deadline/event [NAME] {Additional parameters}`

There are 3 sub-types of task, `ToDo`, `Deadline` and `Event`.
- `ToDo` is added by entering `todo [NAME]`
- `Deadline` is added by entering `deadline [NAME] /by [TIME]`
- `Event` is added by entering `event [NAME] /from [START] /to [END]`

Each type of task has different parameters for time to make it easier to keep track of important dates and times.
Times entered by the user will be stored as-is, and should not include any forward slash characters.

Examples:
- `todo homework`
- `deadline submit group project /by 2230 hours`
Expand All @@ -38,9 +41,11 @@ Examples:

### *Deleting a task:* `delete`
Deletes a `Task`.

Format: `delete [INDEX]`
- Deletes the `Task` at the specified index. Indices start from 1.
- Indices must be a positive integer.

Example:
- `delete 1` Deletes the task at index 1

Expand All @@ -51,11 +56,13 @@ Lists all existing tasks.

### *Locating tasks by keyword* `find`
Finds a task by searching for a single keyword in its name.

Format: `find [KEYWORD]`


### *Marking tasks as done* `mark`,`unmark`
Adds or removes a mark on a task which indicates it as done.

Format: `mark [INDEX]`, `unmark[INDEX]`
- Marks/unmarks the `Task` at the specified index. Indices start from 1.
- Indices must be a positive integer.
Expand Down

0 comments on commit 6f33548

Please sign in to comment.