Initial commitHEADmaster

1 files changed, 44 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f16bb8c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,44 @@
+mp32rss
+=======
+
+mp32rss builds a static website from a set of mp3s in in S3 bucket,
+typically to generate a podcast feed.
+
+Each time it runs, mp32rss scans the S3 bucket for new MP3s then extracts
+the metadata to build RSS feeds or webpages listing the contents. The tool
+keeps an index of previously discovered files in the same s3 bucket to
+avoid downloading the same files more than once.
+
+
+Usage
+=====
+
+Setup
+-----
+
+1. Create an S3 bucket and a static website (you're on your own).
+
+2. Setup the appropriate credentials in a way that the AWS SDK will
+   detect. If the AWS CLI works, you should be good to go.
+
+3. Create your templates to render context. See example/podcast.xml.
+
+4. Install the templates:
+
+      mp32rss --bucket $BUCKET \
+        add-template --index example/podcast.xml podcast.xml
+
+
+Regular usage
+-------------
+
+Each time you upload a file, refresh the feed:
+
+    mp32rss --bucket $BUCKET refresh
+
+
+Contributions
+=============
+
+Send bug reports or patches to jesse@jesterpm.net.
+