summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README48
1 files changed, 48 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..b0644e7
--- /dev/null
+++ b/README
@@ -0,0 +1,48 @@
+Written by: Antti Ajanki <antti.ajanki@iki.fi>
+Project's homepage: http://users.tkk.fi/~aajanki/vdr/webvideo
+
+Webvi is a tool for downloading and playing videos from popular video
+sharing webvites such as YouTube. There are two interfaces: a plugin
+for Video Disk Recorder (VDR), and a command line client. The two
+interfaces are described in README.vdrplugin and README.webvi.
+
+The common functionality of the VDR plugin and the command line client
+is implemented in a Python library (src/libwebvi/webvi). C bindings
+for the library are also provided (see src/libwebvi/libwebvi.h).
+
+Supported video sites:
+
+* Google Video [1]
+* Metacafe
+* MTV3 Katsomo
+* ruutu.fi [2]
+* Subtv
+* SVT Play
+* Vimeo
+* YLE Areena [2]
+* YouTube
+
+[1] Only videos hosted by Google, Youtube, Vimeo and SVT
+
+[2] Requires rtmpdump-yle
+ (http://users.tkk.fi/~aajanki/rtmpdump-yle/index.html). Streaming
+ does not work.
+
+Known problems:
+
+SVT Play: not all videos are working
+MTV3 Katsomo and Subtv: often the connection is lost before the
+ video is fully downloaded.
+
+Because of the modular design it is possible to add support for new
+sites quite easily. See doc/developers.txt for more information.
+
+License:
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 3 of the License, or (at
+your option) any later version. The project includes files from
+iniparse library under MIT license.
+
+See the file COPYING for more information.