README

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..cb61c36
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# YouTubeCgi
+
+YouTubeCgi is a simple tool to dowload videos from YouTube. It is able to fetch normal videos and the protected stuff by doing some Javascript magic.
+
+## Requirements
+
+- python 2.7
+- python-lxml
+- nodejs 4+
+
+## CLI Usage
+
+```
+./youtube.cgi 'https://www.youtube.com/watch?v=QH2-TGUlwu4'
+```
+
+## CGI Usage
+
+You must install the CGI script on your web server. Ensure that you have the dependencies set up correctly and that the httpd/www-data user can access them. It may help to switch to that user and try to run the script in CLI mode.
+
+You can then visit the CGI script and paste in a URL to download videos. Or you can use a bookmarklet:
+
+```
+javascript:(function(){window.location='https://example.com/path/to/youtube.cgi?url='+escape(location);})()
+```