Add a README

README.md

@@ -0,0 +1,29 @@
+# TaskBot
+An automation tool that manages (recurring) tasks stored as issues in a
+[Forgejo](https://forgejo.org/) repository.  It has two main purposes:
+
+- Rescheduling recurring tasks as soon as they are completed.
+- Reminding due tasks with batching at the beginning of the month or week.
+
+## Development
+Create a `.dev-environment.json` file:
+
+```json
+{
+    "dev-token": "<forgejo-api-token>",
+    "server-url": "https://git.example.com",
+    "repo-with-owner": "owner/repo"
+}
+```
+
+Then run:
+
+```bash
+RUST_LOG=debug cargo run
+```
+
+## Deployment
+TaskBot is meant to run in CI where it automatically attaches to the issues of
+the repository it is running from. It should run on a daily schedule.
+
+Documentation on CI integration is TBD.