summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..584d77b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# nixpkgs-tracker-bot
+
+A small Discord ~~bot~~ app(!) that helps you track where [nixpkgs](https://github.com/NixOS/nixpkgs) PRs have reached
+
+## Currently supported branches
+
+- master
+- staging
+- nixos-unstable
+- nixos-unstable-small
+- nixos-24.05-small
+- release-24.05
+- nixos-23.11-small
+- release-23.11
+
+## TODO
+
+- [ ] Cache responses (to avoid rate limiting)
+- [ ] Allow for authenticated requests to GH (to avoid rate limiting)
+- [ ] Don't make so many API requests for each invocation (to avoid rate limiting...this is a problem see?)
+- [ ] Switch to poise after https://github.com/serenity-rs/poise/pull/266