Skip to content

Commit 5556319

Browse files
committed
add README.md
1 parent 1189a56 commit 5556319

1 file changed

Lines changed: 35 additions & 0 deletions

File tree

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Smart Tasker
2+
3+
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.
4+
5+
---
6+
7+
## Features
8+
9+
- Add new tasks from the command line
10+
- List all tasks with their completion status
11+
- Mark tasks as completed
12+
- Delete tasks by ID
13+
- Simple and fast local storage using JSON
14+
15+
---
16+
17+
## Requirements
18+
19+
- Rust and Cargo installed
20+
(Install from https://www.rust-lang.org/tools/install)
21+
22+
---
23+
24+
## How to Use
25+
26+
```bash
27+
# Clone the repo
28+
git clone https://github.com/yourusername/smart-tasker.git
29+
cd smart-tasker
30+
31+
# 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

0 commit comments

Comments
 (0)