aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMelody Horn <melody@boringcactus.com>2021-03-29 21:05:33 -0600
committerMelody Horn <melody@boringcactus.com>2021-03-29 21:05:33 -0600
commit0cf9f29aea49b1f1501fcd4b139ec88d942f244c (patch)
tree59336e8a92d097fc40743385b298730923cf83a5 /README.md
parent3fbdd8c97383df4a67c75a0cc9405d5349854e9b (diff)
downloadwhere-packaged-0cf9f29aea49b1f1501fcd4b139ec88d942f244c.tar.gz
where-packaged-0cf9f29aea49b1f1501fcd4b139ec88d942f244c.zip
put a bow on the damn thing
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..15df425
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# Where Is This Packaged?
+
+A service to make SVG badges showing which package repositories offer something.
+
+**Poorly written, poorly tested, not production ready.**
+
+Only necessary because the existing service that does this [is run by assholes](https://twitter.com/QuinnyPig/status/1376357557191643141).
+
+## Usage
+
+`/badge/<package>.svg` will generate a badge for all the [known](https://code.boringcactus.com/where-packaged/tree/repos) repositories that have a package with that name.
+
+You can override with query string parameters.
+For example, `/badge/rust.svg?crates-io=&debian=rustc&ubuntu=rustc` looks for packages named "rust", but ignores crates.io and looks for "rustc" instead on Debian & Ubuntu.
+
+## Status
+
+I don't know if I intend to finish this up and make it a more permanent service.
+
+## About
+
+Written by [boringcactus / Melody Horn](https://www.boringcactus.com).
+Source code [available](https://code.boringcactus.com/where-packaged/) under the [GLWTPL](https://github.com/me-shaon/GLWTPL).