Skip to content

Commit 589d8ea

Browse files
committed
Simplify README for casual users
- Focus on benefits and quick start commands - Remove technical details to improve approachability - Make instructions clearer and more user-friendly
1 parent 1fa4dad commit 589d8ea

File tree

1 file changed

+14
-42
lines changed

1 file changed

+14
-42
lines changed

README.md

Lines changed: 14 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,28 @@
11
# TaskNow
22

3-
A minimalist terminal task manager that helps you focus on one task at a time, while still providing full task management capabilities.
3+
A super simple terminal to-do app that helps you focus on one task at a time.
44

5-
## Features
5+
## Why use TaskNow?
66

7-
- Single-task focus by default
8-
- Simple command-based interface
9-
- Full task list visibility when needed
10-
- Completion tracking
11-
- JSON-based data storage
12-
- Linux/Ubuntu compatible
7+
- Stay focused by seeing just your current task
8+
- Add, complete, and manage tasks easily from the terminal
9+
- No accounts, no clutter — just your tasks
1310

14-
## Installation
11+
## Quick start
1512

16-
### Using pip and setup.py
17-
18-
1. Clone or download this repository.
19-
2. Navigate to the project directory.
20-
3. Run:
13+
Add a task:
2114

2215
```bash
23-
pip install .
16+
tasknow add "Write report"
2417
```
2518

26-
This will install TaskNow and make the `tasknow` command available globally.
27-
28-
### Requirements
29-
30-
- Python 3.10 or higher
31-
- `setuptools` (installed automatically with pip)
32-
33-
## Usage
34-
35-
Add a new task:
36-
37-
```bash
38-
tasknow add "Write documentation"
39-
```
40-
41-
View your current task:
19+
See your current task:
4220

4321
```bash
4422
tasknow
4523
```
4624

47-
Mark the current task as done:
25+
Mark it done:
4826

4927
```bash
5028
tasknow done
@@ -80,20 +58,14 @@ Edit a task:
8058
tasknow edit 2 "New task description"
8159
```
8260

83-
## Development
84-
85-
Run tests with:
86-
87-
```bash
88-
pytest
89-
```
61+
---
9062

91-
Generate coverage report:
63+
For more commands and details, see the full documentation or run:
9264

9365
```bash
94-
pytest --cov=.
66+
tasknow --help
9567
```
9668

97-
## License
69+
---
9870

9971
MIT License © Decoding Chris

0 commit comments

Comments
 (0)