Skip to content

Commit c0b0a53

Browse files
Readme Update
1 parent 647a271 commit c0b0a53

File tree

1 file changed

+38
-38
lines changed

1 file changed

+38
-38
lines changed

README.md

Lines changed: 38 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
# 🧠 AI-Powered To-Do Manager in Java
1+
# AI-Powered To-Do Manager in Java
22

33
Smart CLI-based task manager that auto-categorizes your tasks using intelligent keyword-based logic. No paid API needed - completely free and runs locally!
44

5-
## 🌟 Features
5+
## Features
66

7-
- **Add Tasks**: Create new tasks with intelligent auto-categorization
8-
- 🏷️ **Smart Categories**: Automatic categorization into Work, Personal, Urgent, or General
9-
- 👀 **View & Filter**: View all tasks, filter by category, status, or search by keywords
10-
- **Task Management**: Mark tasks as complete, delete tasks, clear completed tasks
11-
- 💾 **Persistent Storage**: All data saved locally in JSON format
12-
- 📊 **Analytics**: Task summary with completion rates and category breakdown
13-
- 🔍 **Search**: Find tasks quickly using keyword search
14-
- 🎯 **Confidence Scoring**: See how confident the AI is about categorization
15-
- 🌐 **Deployment Ready**: Can be hosted on subdomain (todo.saurabhh.in)
7+
- **Add Tasks**: Create new tasks with intelligent auto-categorization
8+
- **Smart Categories**: Automatic categorization into Work, Personal, Urgent, or General
9+
- **View & Filter**: View all tasks, filter by category, status, or search by keywords
10+
- **Task Management**: Mark tasks as complete, delete tasks, clear completed tasks
11+
- **Persistent Storage**: All data saved locally in JSON format
12+
- **Analytics**: Task summary with completion rates and category breakdown
13+
- **Search**: Find tasks quickly using keyword search
14+
- **Confidence Scoring**: See how confident the AI is about categorization
15+
- **Deployment Ready**: Can be hosted on subdomain (todo.saurabhh.in)
1616

17-
## 🧠 AI Categorization Logic
17+
## AI Categorization Logic
1818

1919
Tasks are automatically categorized based on keyword analysis:
2020

@@ -24,13 +24,13 @@ Keywords: `office`, `project`, `client`, `meeting`, `presentation`, `report`, `d
2424
### 👤 Personal Category
2525
Keywords: `birthday`, `family`, `shopping`, `grocery`, `home`, `house`, `personal`, `friend`, `vacation`, `holiday`, `doctor`, `appointment`, `health`, `exercise`, `gym`, `hobby`, `book`, `movie`, `restaurant`, `dinner`, `lunch`, `breakfast`, `party`, `celebration`, `gift`, `anniversary`, `wedding`, `travel`, `trip`, `visit`, `clean`, `organize`, `repair`, `maintenance`, `garden`, `pet`, `car`, `insurance`, `bank`, `finance`
2626

27-
### 🚨 Urgent Category
27+
### Urgent Category
2828
Keywords: `urgent`, `asap`, `immediately`, `now`, `today`, `emergency`, `critical`, `important`, `priority`, `rush`, `quick`, `fast`, `soon`, `deadline`, `overdue`, `late`, `must`, `need`, `required`, `essential`, `crucial`, `vital`, `pressing`, `time-sensitive`, `hurry`, `instant`, `immediate`
2929

30-
### 📝 General Category
30+
### General Category
3131
Default category for tasks that don't match any specific keywords.
3232

33-
## 🚀 Quick Start
33+
## Quick Start
3434

3535
### Prerequisites
3636
- Java 17 or higher
@@ -81,28 +81,28 @@ ai-todo-manager/
8181
└── .gitignore # Git ignore rules
8282
```
8383

84-
## 💻 Usage Examples
84+
## Usage Examples
8585

8686
### Adding Tasks
8787
```
88-
👉 Enter task title: Submit client proposal by Friday
89-
Task added successfully!
90-
📝 Title: Submit client proposal by Friday
91-
🏷️ Category: 💼 Work
92-
🎯 Confidence: 85%
93-
👍 Good categorization! Consider adding more specific keywords for better accuracy.
88+
Enter task title: Submit client proposal by Friday
89+
Task added successfully!
90+
Title: Submit client proposal by Friday
91+
Category: Work
92+
Confidence: 85%
93+
Good categorization! Consider adding more specific keywords for better accuracy.
9494
```
9595

9696
### Viewing Tasks
9797
```
98-
📋 ALL TASKS
98+
ALL TASKS
9999
==================================================
100-
1. Submit client proposal [💼Work] - PENDING (Created: 2024-01-15 09:30:00)
101-
2. Buy birthday gift for mom [👤Personal] - COMPLETED (Created: 2024-01-15 10:15:00) (Completed: 2024-01-15 18:30:00)
102-
3. Urgent: Fix server issue ASAP [🚨Urgent] - PENDING (Created: 2024-01-15 08:00:00)
100+
1. Submit client proposal [Work] - PENDING (Created: 2025-01-15 09:30:00)
101+
2. Buy birthday gift for mom [Personal] - COMPLETED (Created: 2025-01-15 10:15:00) (Completed: 2025-01-15 18:30:00)
102+
3. Urgent: Fix server issue ASAP [Urgent] - PENDING (Created: 2025-01-15 08:00:00)
103103
```
104104

105-
## 🌐 Deployment to Subdomain (todo.saurabhh.in)
105+
## Deployment to Subdomain (todo.saurabhh.in)
106106

107107
### Step 1: Package the Application
108108
```bash
@@ -155,7 +155,7 @@ Add A Record in your domain provider (Hostinger):
155155
- **Value**: `your_server_ip`
156156
- **TTL**: `3600`
157157

158-
## 📊 Sample tasks.json Format
158+
## Sample tasks.json Format
159159

160160
```json
161161
[
@@ -176,7 +176,7 @@ Add A Record in your domain provider (Hostinger):
176176
]
177177
```
178178

179-
## 🛠️ Technologies Used
179+
## Technologies Used
180180

181181
- **Java 17+**: Core programming language
182182
- **Maven**: Dependency management and build tool
@@ -185,9 +185,9 @@ Add A Record in your domain provider (Hostinger):
185185
- **Apache/Nginx**: Web server for deployment
186186
- **JSON**: Local data storage format
187187

188-
## 🎯 Development Roadmap
188+
## Development Roadmap
189189

190-
### Day 1
190+
### Day 1
191191
- [x] Project setup and Maven configuration
192192
- [x] Core classes: Task, TaskManager, AICategorizer, Main
193193
- [x] Basic CRUD operations
@@ -212,26 +212,26 @@ Add A Record in your domain provider (Hostinger):
212212
- [ ] Documentation completion
213213
- [ ] Testing and bug fixes
214214

215-
## 🤝 Contributing
215+
## Contributing
216216

217217
1. Fork the repository
218218
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
219219
3. Commit your changes (`git commit -m 'Add amazing feature'`)
220220
4. Push to the branch (`git push origin feature/amazing-feature`)
221221
5. Open a Pull Request
222222

223-
## 📝 License
223+
## License
224224

225225
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
226226

227-
## 👨‍💻 Author
227+
## Author
228228

229229
**Saurabh**
230-
- 🌐 Website: [saurabhh.in](https://saurabhh.in)
231-
- 📧 Email: contact@saurabhh.in
232-
- 🚀 Live Demo: [todo.saurabhh.in](https://todo.saurabhh.in)
230+
- Portfolio: [saurabhh.in](https://saurabhh.in)
231+
- Email: Saurabbh@wearl.co.in
232+
- Live Demo: [todo.saurabhh.in](https://todo.saurabhh.in)
233233

234-
## 🙏 Acknowledgments
234+
## Acknowledgments
235235

236236
- Thanks to the Java community for excellent documentation
237237
- Gson library for seamless JSON handling

0 commit comments

Comments
 (0)