Skip to content

Commit 7a04749

Browse files
authored
Update README.md
1 parent b1690b0 commit 7a04749

1 file changed

Lines changed: 41 additions & 13 deletions

File tree

README.md

Lines changed: 41 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
Smart Tasker is a command-line task tracker built with Rust. It lets you add, list, complete, and delete tasks directly from the terminal. All tasks are stored in a local JSON file (`data/tasks.json`), so there is no need for a database or external setup.
44

5-
---
6-
75
## Features
86

97
- Add new tasks from the command line
@@ -12,24 +10,54 @@ Smart Tasker is a command-line task tracker built with Rust. It lets you add, li
1210
- Delete tasks by ID
1311
- Simple and fast local storage using JSON
1412

15-
---
16-
1713
## Requirements
1814

1915
- Rust and Cargo installed
2016
(Install from https://www.rust-lang.org/tools/install)
2117

22-
---
23-
2418
## How to Use
2519

2620
```bash
2721
# Clone the repo
28-
git clone https://github.com/Webrowse/smart-cli-tasker.git
29-
cd smart-cli-tasker
30-
```
22+
git clone https://github.com/yourusername/smart-tasker.git
23+
cd smart-tasker
24+
3125
# Run any command with cargo
32-
- cargo run -- add "Write documentation"
33-
- cargo run -- list
34-
- cargo run -- complete 2
35-
- cargo run -- delete 1
26+
cargo run -- add "Write documentation"
27+
cargo run -- list
28+
cargo run -- complete 2
29+
cargo run -- delete 1
30+
```
31+
32+
## Command Reference
33+
34+
| Command | Description |
35+
|---------------------|--------------------------------------|
36+
| `add "task desc"` | Add a new task |
37+
| `list` | Show all tasks |
38+
| `complete <id>` | Mark the task with given ID complete |
39+
| `delete <id>` | Delete the task with given ID |
40+
41+
Task IDs are shown in the `list` output. Start from 1.
42+
43+
## File Structure
44+
45+
```
46+
src/
47+
├── main.rs # CLI entry point and Clap logic
48+
├── commands/ # add.rs, list.rs, complete.rs, delete.rs
49+
├── models/ # task.rs (Task struct, derives Serde)
50+
├── storage/ # file.rs (load, save, show)
51+
data/
52+
└── tasks.json # Local JSON file storing tasks
53+
```
54+
55+
## License
56+
57+
This project is open source and freely usable under the MIT license.
58+
See `LICENSE` for details.
59+
60+
## Author
61+
62+
Created by Adarsh as a hands-on project while learning Rust.
63+
Feel free to fork, improve, or use it as a learning reference.

0 commit comments

Comments
 (0)