aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6f86cbc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+vk2rss -- граббер ленты сообществ и пабликов ВКонтакте в RSS
+============================================================
+
+Программа vk2rss создана для конвертации ленты из паблика или группы ВКонтакте
+в формат RSS. Иногда это бывает полезно, если у вас уже есть RSS-ридер, в
+котором вы бы хотели видеть посты какого-нибудь редкого сообщества, у которого
+нет отдельного сайта с экспортом их ленты в RSS.
+
+Зависимости
+-----------
+
+- lua
+- cjson (установить можно через luarocks)
+- wget || curl
+
+Как использовать
+----------------
+
+./vk2rss <название_группы/паблика> [access token]
+
+На stdout: XML в RSS-формате с постами (последние 100 штук).
+В случае, если группа закрытая, необходимо предоставить access token.
+
+Access token
+------------
+
+Для его получения обратитесь к инструкции на стр. `https://new.vk.com/dev/auth_mobile`
+Пример: `https://oauth.vk.com/authorize?client_id=1&display=page&scope=offline&redirect_uri=https://oauth.vk.com/blank.html&response_type=token&v=5.52`