1 files changed, 30 insertions, 0 deletions
diff --git a/docs/salvador.md b/docs/salvador.md
new file mode 100644
index 0000000..c1206b0
--- /dev/null
+++ b/docs/salvador.md
@@ -0,0 +1,30 @@
+# salvador
+
+Image-to-IRC art bot. Converts an image URL into mIRC colour art using
+half-block characters and Floyd-Steinberg dithering against the 99-colour
+mIRC palette.
+
+## Dependencies
+
+```
+pip install Pillow
+```
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `!draw <url>` | Render image at default height (6 lines) |
+| `!draw <lines> <url>` | Render at custom height (4-12 lines) |
+
+The image is fetched, resized to fit within 60 chars wide, dithered to the
+mIRC palette, and output line by line with a 0.4s flood delay between lines.
+Images up to 5 MB are accepted; the Content-Type must be `image/*`.
+
+### Admin (owner)
+| Command | Description |
+|---------|-------------|
+| `!join #channel` | Join a channel |
+| `!part [#channel]` | Leave a channel |
+| `!chans` | List channels |
+| `!help` | Show usage (PM) |