From 32cdb8581071f3abc54c72db5801ea19eaeb8498 Mon Sep 17 00:00:00 2001
From: Christopher Rosell <chrippa@tanuki.se>
Date: Thu, 19 Jan 2012 23:29:28 +0100
Subject: Use a markdown README instead.

---
 README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7a282eb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,49 @@
+Livestreamer
+============
+CLI program that helps launch various streaming services in a real player instead of flash.
+
+
+Installing
+----------
+    $ sudo python setup.py install
+Livestreamer is compatible with Python version >= 2.6 and 3.0.
+
+
+Using
+-----
+    $ livestreamer --help
+
+
+Example usage
+-------------
+Find out what stream qualities are available
+
+    $ livestreamer http://www.twitch.tv/ignproleague
+    Found streams: 240p, 360p, 480p, 720p, iphonehigh, iphonelow, live
+
+Now play one of them
+
+    $ livestreamer http://www.twitch.tv/ignproleague 720p
+
+Stream now playbacks in default player (VLC).
+
+
+Saving arguments AKA config file
+--------------------------------
+Livestreamer can read arguments from the file ~/.livestreamerrc.
+A example file:
+
+    player=mplayer
+    jtv-cookie=_jtv3_session_id=arandomhash
+
+
+Notes
+-----
+Currently supported sites are:
+
+* Justin.tv/Twitch.tv
+* Own3D.tv
+* UStream
+
+Justin.tv plugin requires rtmpdump with jtv token support (recent git).
+
-- 
cgit v1.2.3