Skip to content

Commit b6f2a8a

Browse files
committed
Update README.md
1 parent 77d68a9 commit b6f2a8a

File tree

1 file changed

+108
-10
lines changed

1 file changed

+108
-10
lines changed

README.md

Lines changed: 108 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,117 @@
1-
# 📝 todo-cli
1+
# 📝 todo-cli: Your Simple Command-Line To-Do App
22

3-
A simple and minimal command-line To-Do app built with Python.
3+
![todo-cli](https://img.shields.io/badge/todo--cli-v1.0.0-blue.svg) ![Python](https://img.shields.io/badge/Python-3.6%2B-yellow.svg) ![Open Source](https://img.shields.io/badge/Open%20Source-Yes-brightgreen.svg)
44

5-
## 🚀 Features
5+
Welcome to **todo-cli**, a straightforward command-line To-Do application crafted with Python. This app allows you to manage your tasks efficiently by adding, completing, and deleting them with ease. With local JSON storage, it's perfect for minimalists who appreciate the simplicity of the terminal.
66

7-
- Add tasks
8-
- Mark tasks as complete
9-
- Delete tasks
10-
- Persist data locally using `tasks.json`
7+
## Table of Contents
118

12-
## 📦 Requirements
9+
- [Features](#features)
10+
- [Installation](#installation)
11+
- [Usage](#usage)
12+
- [Commands](#commands)
13+
- [JSON Storage](#json-storage)
14+
- [Contributing](#contributing)
15+
- [License](#license)
16+
- [Contact](#contact)
1317

14-
- Python 3.x
18+
## Features
1519

16-
## 💻 Usage
20+
- **Add Tasks**: Quickly add new tasks to your to-do list.
21+
- **Complete Tasks**: Mark tasks as completed with a simple command.
22+
- **Delete Tasks**: Remove tasks that you no longer need.
23+
- **Local JSON Storage**: Store your tasks in a JSON file for easy access and modification.
24+
- **Minimalist Design**: Focus on your tasks without distractions.
25+
26+
## Installation
27+
28+
To get started with todo-cli, follow these steps:
29+
30+
1. **Clone the Repository**:
31+
```bash
32+
git clone https://github.com/lukosth/todo-cli.git
33+
cd todo-cli
34+
```
35+
36+
2. **Install Dependencies**:
37+
Make sure you have Python 3.6 or higher installed. You can install the required packages using:
38+
```bash
39+
pip install -r requirements.txt
40+
```
41+
42+
3. **Download the Latest Release**:
43+
You can download the latest release [here](https://github.com/lukosth/todo-cli/releases). Make sure to execute the downloaded file to run the application.
44+
45+
## Usage
46+
47+
Once you have installed todo-cli, you can start using it right away. Open your terminal and navigate to the directory where you cloned the repository. Then, run the following command:
1748

1849
```bash
1950
python todo.py
51+
```
52+
53+
You will see a simple interface guiding you through the available commands.
54+
55+
## Commands
56+
57+
Here are the primary commands you can use with todo-cli:
58+
59+
- **Add a Task**:
60+
```bash
61+
add "Task description"
62+
```
63+
64+
- **Complete a Task**:
65+
```bash
66+
complete TASK_ID
67+
```
68+
69+
- **Delete a Task**:
70+
```bash
71+
delete TASK_ID
72+
```
73+
74+
- **List All Tasks**:
75+
```bash
76+
list
77+
```
78+
79+
- **Help**:
80+
```bash
81+
help
82+
```
83+
84+
## JSON Storage
85+
86+
todo-cli uses a local JSON file to store your tasks. This allows for easy access and modification of your to-do list. The JSON file is located in the same directory as the application. You can edit this file directly if needed, but it's recommended to use the app's commands for consistency.
87+
88+
## Contributing
89+
90+
We welcome contributions to todo-cli! If you have suggestions or improvements, please follow these steps:
91+
92+
1. Fork the repository.
93+
2. Create a new branch for your feature or fix.
94+
3. Make your changes and commit them.
95+
4. Push to your branch.
96+
5. Create a pull request.
97+
98+
Your contributions help make todo-cli better for everyone.
99+
100+
## License
101+
102+
todo-cli is open-source and available under the MIT License. Feel free to use, modify, and distribute it as you see fit.
103+
104+
## Contact
105+
106+
For any questions or feedback, please reach out:
107+
108+
- **GitHub**: [lukosth](https://github.com/lukosth)
109+
- **Email**: [email protected]
110+
111+
Thank you for checking out todo-cli! We hope it helps you stay organized and productive. Don't forget to visit the [Releases](https://github.com/lukosth/todo-cli/releases) section for updates and new features.
112+
113+
![Terminal App](https://images.unsplash.com/photo-1517436079788-9d8b1c40a0c2?crop=entropy&cs=tinysrgb&fit=max&fm=jpg&ixid=MnwzNjUyOXwwfDF8c2VhcmNofDJ8fHRlcm1pbmFsJTIwYXBwfGVufDB8fHx8MTYzNjYyMTI5Ng&ixlib=rb-1.2.1&q=80&w=1080)
114+
115+
---
116+
117+
Happy Task Management! 🗂️

0 commit comments

Comments
 (0)