From 943199b16c7b96b446bb9a03557eb548e06fec90 Mon Sep 17 00:00:00 2001
From: Tibor Baksa <baksatibi@gmail.com>
Date: Sat, 9 Sep 2017 18:12:45 +0200
Subject: [PATCH] Added README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c7e1565
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# vlc-mediaklikk
+VLC playlist parser for MédiaKlikk videos and video streams
+
+## Installation
+Copy [mediaklikk.lua](mediaklikk.lua) to [VLC Lua playlist scripts](https://wiki.videolan.org/Documentation:Building_Lua_Playlist_Scripts/#Introduction).
+
+### Directory for all users
+* Linux: `/usr/share/vlc/lua/playlist/`
+* Mac OS X: `VLC.app/Contents/MacOS/share/lua/playlist/`
+* Windows: `C:\Program Files\VideoLAN\VLC\lua\playlist\`
+
+### Directory for the current user
+* Linux: `~/.local/share/vlc/lua/playlist/`
+* Mac OS X: `~/Library/Application Support/org.videolan.vlc/lua/playlist/`
+* Windows: `%APPDATA%\vlc\lua\playlist\`
+
+## Supported sites
+
+### Videos
+* [hirado.hu](https://www.hirado.hu/)
+* [m4sport.hu](https://www.m4sport.hu/)
+* [mediaklikk.hu](https://www.mediaklikk.hu/)
+
+### Video streams
+* [M1](https://www.mediaklikk.hu/m1-elo)
+* [M2](https://www.mediaklikk.hu/m2-elo)
+* [M4](https://www.mediaklikk.hu/m4-elo)
+* [M5](https://www.mediaklikk.hu/m5-elo)
+* [Duna](https://www.mediaklikk.hu/duna-elo)
+* [Duna World](https://www.mediaklikk.hu/duna-world-elo)
+
+Video streams require VLC 3.0+ (currently available from [nightly builds](https://nightlies.videolan.org/)).