aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1f9d32c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+youtube-feed
+============
+
+Combine multiple YouTube user feeds into a single RSS-Feed.
+
+Compiling
+---------
+
+`go get github.com/kch42/youtube-feed`
+
+Usage
+-----
+
+Put all the usernames of YouTubers you want to receive updates from into the file `~/.youtube-feed`.
+`youtube-feed` will now output the combined feed on `stdout`. You can use youtube-feed with [newsbeuter](http://www.newsbeuter.org). Just put `exec:youtube-feed` into your `urls` file.