amy/donetick
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Mohamad Tarbin 2025-01-19 18:01:46 -05:00 • committed by GitHub
parent 6ca8d8bef1
commit e7d9269563
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 12 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -5,7 +5,7 @@
**Simplify Tasks & Chores, Together!**
Donetick is an open-source, user-friendly app designed to help you organize tasks and chores effectively.featuring customizable options to help you and others stay organized
Donetick is an open-source, user-friendly app designed to help you organize tasks and chores effectively. featuring customizable options to help you and others stay organized
![Screenshot](assets/screenshot.png)
@ -23,7 +23,9 @@ Donetick is an open-source, user-friendly app designed to help you organize task
## ✨ Features
🏰 Group-Based Task Management: Create and manage tasks for solo or with your family or friends in shared circles.
🏰 Group-Based Task Management: Create and manage tasks solo or with your family or friends in shared circles.
✨ One-Sentence Task Creation[Experimental] : Create tasks by simply describing them in a sentence. Donetick intelligently extracts dates, times, and recurrence patterns from your natural language. For example, "Change water filter every 6 months" or "Take the trash out every Monday and Tuesday at 6:15 pm" will automatically generate the correct tasks.
🔄 Smart Assignments: Assign tasks to individuals with rotation strategies like random or least completed.
@ -49,7 +51,13 @@ viewing tasks directly in supported platforms (e.g., Home Assistant with a custo
---
## 🚀 Quick Start
make sure you update the `config/selfhosted.yaml`
> [!NOTE]
> Before running the application, ensure you have a valid `selfhosted.yaml` configuration file.
> If you don't have one, create a `selfhosted.yaml` file based on the example provided [here](https://github.com/donetick/donetick/blob/main/config/selfhosted.yaml).
> Place the `selfhosted.yaml` file in the `/config` directory within your application's root directory
### Using Docker
1. **Pull the latest image:**
```bash
@ -163,4 +171,4 @@ For ideas or feature requests, please use GitHub Discussions. We also have a Dis
If you find it helpful, consider supporting us by starring the repository, contributing code, or sharing feedback!
---
---