Skip to content

Commit 718d0f1

Browse files
committed
Update readme
1 parent 575062f commit 718d0f1

File tree

1 file changed

+37
-8
lines changed

1 file changed

+37
-8
lines changed

README.md

Lines changed: 37 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,48 @@
11
# Todolator
22

3+
Todolator is a simple desktop task reminder designed to ensure it is hard to ignore the reminder (unlike other apps using push or in-brwoser notifications).
4+
5+
## Why
6+
7+
I created Todolator because usual push notifications or in-browser notifications from apps like Google Calendar are not enough to grab my attention and not forget the task at hand. I also had experience with desktop apps like [Kana](https://kanasolution.com/products/kana-reminder/) and [Desktop Reminder](https://www.desktop-reminder.com/en/index.html), however these are now quite outdated and/or not completely free.
8+
9+
I also wanted to create a desktop app, learn the basics of Rust and use Tauri - so I can combined all of these in this project.
10+
11+
## Use Cases
12+
13+
- Reminding of important, one-time tasks
14+
- E.g. an important meeting
15+
- Reminding of recurring tasks
16+
- E.g. paying your bills
17+
- Combination of the 2 UCs above
18+
19+
## Privacy
20+
21+
Your data stays on your computer, you decide what to do with it. Todolator uses no telemetry, stores no data about you and does not require internet connection.
22+
323
## Configuration
424

5-
Your tasks and settings' location will depend on your OS:
25+
### App Data Directory
26+
27+
The app data directory location depends on the OS used:
28+
29+
**Windows:**
30+
31+
- `C:\Users\<Username>\AppData\Roaming\Todolator`
32+
33+
**Linux:**
634

7-
**Windows**
35+
- `/home/<username>/.local/share/Todolator`
836

9-
- ``
37+
**MacOS:**
1038

11-
**Linux**
39+
- `/Users/<Username>/Library/Application Support/Todolator`
1240

13-
- ``
41+
In the location, you can find `tasks.json` holding your tasks, `settings.json` containing app settings and `resources/alarm.mp3` containing the alarm notification sound.
1442

15-
**MacOS**
43+
### Changing the notification sound
1644

17-
- ``
45+
Simply replace the default `alarm.mp3` file in the `resources` directory located inside of the app data directory (see above).
1846

1947
## Run Locally
2048

@@ -33,6 +61,7 @@ The built binary & installers will be created in `src-tauri/target/release`.
3361

3462
## TODO
3563

64+
- LICENCE
3665
- Try building for MacOS via GHA pipeline provided by tauri
3766
- Mention in readme the location of `tasks.json`, `settings.json` and `alarm.mp3`
3867
- Calendar units for recurrence
@@ -42,7 +71,7 @@ The built binary & installers will be created in `src-tauri/target/release`.
4271

4372
- MacOS release
4473
- Fix title bar (<https://v2.tauri.app/learn/window-customization/#creating-a-custom-titlebar>)
45-
- Clean up the app data folder when uninstalling (maybe make it optional with a checkbox?)
74+
- Clean up the app data directory when uninstalling (maybe make it optional with a checkbox?)
4675
- Import/Export tasks
4776
- Filtering & Sorting tasks
4877
- Configurable hotkeys

0 commit comments

Comments
 (0)