From 05de07dfa75157e8996e53ac60dad6c465caf8cc Mon Sep 17 00:00:00 2001
From: Yuki Joou <yukijoou@kemonomimi.gay>
Date: Sun, 10 Nov 2024 16:36:13 +0100
Subject: [PATCH] Added README.md

---
 README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..463e48e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# pack2task
+
+Utility scripts for tracking package delivery progress and setting
+CalDAV reminders to go pick them up!
+
+## Status
+
+This is still very much a work-in-progress! But I intend on
+developping this as much as possible and supporting as many delivery
+trackers as possible!
+
+## Usage
+
+1. Clone the repo
+2. Create `~/.config/pack2task/config.json`. It should have the following content:
+```json
+{
+	"login": "username:password for your CalDAV server",
+	"calendar": "https:// - path to the CalDAV calendar where you want your events to go"
+}
+```
+3. Add a package to track using `pack2task-add.sh <URL to tracker>`
+4. Periodically run `pack2taskd.sh`. You should run it by hand the first time to make sure it works!
+
+## Supported trackers
+
+* MondialRelay (France)