Skip to content

Commit

Permalink
Update User Guide
Browse files Browse the repository at this point in the history
  • Loading branch information
Kishen271828 committed Mar 10, 2024
1 parent db75b15 commit a023d32
Showing 1 changed file with 40 additions and 4 deletions.
44 changes: 40 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,50 @@
# User Guide

Nehsik is a CLI-based Personal Assistant ChatBot that helps the user to keep track of their daily tasks

## Features

### Feature-ABC
### Add tasks : `todo`, `deadline`, `event`

Tasks of the following types can be added:
- **Todo**: Contains task description only
- **Deadline**: Contains task description and the deadline time
- **Event**: Contains task description and the duration of the event

Format: `todo TASK_DESCRIPTION` `deadline TASK_DESCRIPTION /by DEADLINE` `event TASK_DESCRIPTION /from START_TIME /to END_TIME`

### List tasks : `list`

Displays all the tasks present in the task list.
Format: `list`

### Delete task : `delete`

Deletes the required task based on the task number of the task to be deleted in the latest task list.
Format: `delete TASK_NUM`

### Mark task : `mark`

Marks the required task as done based on the task number of the task to be marked as done in the latest task list.
Format: `mark TASK_NUM`

### Unmark task : `unmark`

Marks the required task as not done based on the task number of the task to be marked as not done in the latest task list.
Format: `unmark TASK_NUM`

### Find task : `find`

Description of the feature.
Displays the list of matching tasks which contain the keyword in their descriptions.
Format: `find KEYWORD`

### Feature-XYZ
### Exit : `bye`
Displays bye message and exits from the program.
Format: `bye`

Description of the feature.
### Saving the data
Data is saved in the hard disk automatically after any command that changes the data. There is no need to save manually.
Your task list can be found in the "nehsik.txt" file created in the same directory where the Nehsik.jar file is present.

## Usage

Expand Down

0 comments on commit a023d32

Please sign in to comment.