Skip to content

Commit 2372238

Browse files
committed
Improve documentation: add installation instructions, requirements, links, license; bump version to 1.0.5
1 parent 954e970 commit 2372238

File tree

2 files changed

+53
-5
lines changed

2 files changed

+53
-5
lines changed

README.md

Lines changed: 44 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,39 @@
22

33
A super simple terminal to-do app that helps you focus on one task at a time.
44

5+
[![PyPI version](https://img.shields.io/pypi/v/tasknow.svg)](https://pypi.org/project/tasknow/)
6+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
7+
8+
---
9+
510
## Why use TaskNow?
611

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
12+
- **Stay focused:** See just your current task by default
13+
- **Minimalist & distraction-free:** No accounts, no clutter — just your tasks
14+
- **Full control:** Add, complete, edit, and manage tasks easily from the terminal
15+
- **Simple commands:** Intuitive CLI interface
16+
- **Lightweight:** Python-based with JSON storage, works seamlessly on Linux
17+
18+
---
19+
20+
## Requirements
21+
22+
- **Python 3.10 or higher**
23+
- Compatible with Ubuntu/Linux systems
24+
25+
---
26+
27+
## Installation
28+
29+
Install TaskNow directly from PyPI:
30+
31+
```bash
32+
pip install tasknow
33+
```
34+
35+
---
1036

11-
## Quick start
37+
## Quick Start
1238

1339
Add a task:
1440

@@ -68,4 +94,18 @@ tasknow --help
6894

6995
---
7096

97+
## Links
98+
99+
- **PyPI:** [https://pypi.org/project/tasknow/](https://pypi.org/project/tasknow/)
100+
- **Source Code:** [https://github.com/decodingchris/tasknow](https://github.com/decodingchris/tasknow)
101+
- **Issue Tracker:** [https://github.com/decodingchris/tasknow/issues](https://github.com/decodingchris/tasknow/issues)
102+
103+
---
104+
105+
## License
106+
107+
This project is licensed under the **MIT License**. See the [LICENSE](https://opensource.org/licenses/MIT) file for details.
108+
109+
---
110+
71111
MIT License © Decoding Chris

setup.py

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
setup(
44
name="tasknow",
5-
version="1.0.4",
5+
version="1.0.5",
66
description="A super simple terminal to-do app that helps you focus on one task at a time.",
77
long_description="""# TaskNow
88
@@ -14,6 +14,14 @@
1414
- Add, complete, and manage tasks easily from the terminal
1515
- No accounts, no clutter — just your tasks
1616
17+
## Installation
18+
19+
You can install TaskNow directly from PyPI:
20+
21+
```bash
22+
pip install tasknow
23+
```
24+
1725
## Commands
1826
1927
Add a task:

0 commit comments

Comments
 (0)