From 29416d4a716ced3ea5efefe348bf63eec2497c7b Mon Sep 17 00:00:00 2001 From: Autumn Date: Sun, 23 Aug 2026 22:40:06 +0100 Subject: [meta] improved README --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 2fae260..a079f52 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,15 @@ # Bunnytask Bunnytask is a simple TODO.TXT manager, written in [Hare](https://harelang.org/). + +## Configuration + +The config file should be located at `${XDG_CONFIG_HOME}/bunnytask/config.ini` & is required to run. The following configuration options are available: + +* `todo_path` *(required)*: the location of the TODO.TXT file(s). Supports multiple entries *(for multiple to-do files)* & `~`. + +## Contributing + +Patches & bug reports are welcome! Simply email the patch to [bugs+bunnytask@autumnfo.rest](mailto:bugs+bunnytask@autumnfo.rest) and I will take a look. :3 + +No LLM / AI-assisted contributions welcome - if you do I will explosion you. -- cgit v1.3