Skip to content

Commit 41d2647

Browse files
authored
Update README.md
added github release link added crate.io link
1 parent 373c4bb commit 41d2647

1 file changed

Lines changed: 47 additions & 24 deletions

File tree

README.md

Lines changed: 47 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,56 @@
11
# Smart Tasker
22

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.
3+
[![Crates.io](https://img.shields.io/crates/v/smart-tasker)](https://crates.io/crates/smart-tasker)
4+
5+
Smart Tasker is a fast, lightweight command-line task tracker written in Rust. It lets you add, list, complete, and delete tasks directly from the terminal. All tasks are saved locally in a JSON file (`data/tasks.json`) — no database or external setup required.
6+
7+
---
8+
9+
## Install via Cargo
10+
11+
```bash
12+
cargo install smart-tasker
13+
```
14+
15+
Once installed, use it globally:
16+
17+
```bash
18+
smart-tasker add "Write documentation"
19+
smart-tasker list
20+
smart-tasker complete 2
21+
smart-tasker delete 1
22+
```
23+
24+
---
425

526
## Features
627

728
- Add new tasks from the command line
829
- List all tasks with their completion status
930
- Mark tasks as completed
1031
- Delete tasks by ID
11-
- Simple and fast local storage using JSON
32+
- Simple local JSON storage
33+
34+
---
1235

1336
## Requirements
1437

15-
- Rust and Cargo installed
16-
(Install from https://www.rust-lang.org/tools/install)
38+
- [Rust and Cargo](https://www.rust-lang.org/tools/install)
1739

18-
## How to Use
19-
20-
```bash
21-
# Clone the repo
22-
git clone https://github.com/yourusername/smart-tasker.git
23-
cd smart-tasker
24-
25-
# Run any command with cargo
26-
cargo run -- add "Write documentation"
27-
cargo run -- list
28-
cargo run -- complete 2
29-
cargo run -- delete 1
30-
```
40+
---
3141

3242
## Command Reference
3343

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 |
44+
| Command | Description |
45+
|------------------------------|---------------------------------|
46+
| `add "task desc"` | Add a new task |
47+
| `list` | Show all tasks |
48+
| `complete <id>` | Mark the task with given ID complete |
49+
| `delete <id>` | Delete the task with given ID |
50+
51+
> Task IDs are shown in the list output. They start from 1.
4052
41-
Task IDs are shown in the `list` output. Start from 1.
53+
---
4254

4355
## File Structure
4456

@@ -52,11 +64,22 @@ data/
5264
└── tasks.json # Local JSON file storing tasks
5365
```
5466

67+
---
68+
69+
## Links
70+
71+
- [Crates.io Package](https://crates.io/crates/smart-tasker)
72+
- [GitHub Releases](https://github.com/webrowse/smart-cli-tasker/releases)
73+
74+
---
75+
5576
## License
5677

5778
This project is open source and freely usable under the MIT license.
5879
See `LICENSE` for details.
5980

81+
---
82+
6083
## Author
6184

6285
Created by Adarsh as a hands-on project while learning Rust.

0 commit comments

Comments
 (0)