From 34caf4b8a91f6ce7365422e1dbecb0d475d699f9 Mon Sep 17 00:00:00 2001
From: ugrnm <ultrageranium@bleu255.com>
Date: Sun, 9 Oct 2022 17:44:20 +0200
Subject: [PATCH] some doc

---
 README.md | 40 +++++++++++++++++++++++++++++++++++++++-
 1 file changed, 39 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index b5c1751..9f698c5 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,40 @@
-# radio-looptober
+radio-looptober
+===============
+
+Can somehow download MP3 files posted under #looptober tag and turn that into
+a radio stream that for sure will be listened by billions across the fedi.
+
+
+BUT HOW
+-------
+
+There are two scripts:
+* stream_loooooops.sh
+  * wrapper around ezstream
+  * takes a playlist and streams it
+* download_loooooops.py
+  * gets latest toots tagged with #looptoper
+  * download all the attachment if new
+  * generates new playlist and tells ezstream to reload it
+
+
+USAGE
+-----
+
+Quick and dirty, two tmux panes:
+* `while true; do ./download_loooooops.py && sleep 1d; done`
+* `stream_loooooops.sh`
+
+You can start whichever you want firt.
+
+
+AGPL + DONATIONWARE
+-------------------
+
+devi is dual licensed AGPL and donationware.
+If you find radio-looptober useful and can afford it, a donation to LURK is
+greatly appreciated :)
+
+https://opencollective.com/lurk
+