thechef/todo-local
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Update README.md

Browse Source
This commit is contained in:
The Chef
2025-04-09 16:03:23 +00:00
parent 5e5931616b
commit 0e06951782
1 changed files with 16 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@@ -3,8 +3,19 @@
A CLI to-do app written in Rust.
## List of Commands
- [ ] `todo list`        - lists all the tasks (should be numbered)
- [ ] `todo add {}`       - adds {} to the tasks
- [ ] `todo did {number}`    - mark a numbered task as completed
- [ ] `todo undid {number}`   - mark a numbered task as incomplete
- [ ] `todo done`        - lists all the completed tasks
| Implemented | Command | Description |
|-------------|---------|-------------|
| [ ] | `todo list` | lists all the incomplete tasks (should be numbered) |
| [ ] | `todo list --done` | lists all the completed tasks |
| [ ] | `todo list --all` | lists all the completed tasks |
| [ ] | `todo list --category {_category_}` | lists all the tasks of the category \_category\_ |
| [ ] | `todo add {_task_}` | adds \_task\_ to the tasks |
| [ ] | `todo add --category {_category_} {_task_}` | adds \_task\_ to the tasks with category \_category\_ |
| [ ] | `todo did {_number_}` | mark a task with number \_number\_ as completed |
| [ ] | `todo undid {_number_}` | mark a task with number \_number\_ as not completed |
| [ ] | `todo update --category {new_category} {}` | updates the category of existing task |
__Example of todo lists__ <br>
| __ID__ | __Name__ | __category__ |
| -------| ---------| --------------|
| 5 | Finish Todo App | side-project |