aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEvgeny Kuznetsov <evgeny@kuznetsov.md>2019-06-17 17:29:54 +0300
committerEvgeny Kuznetsov <evgeny@kuznetsov.md>2019-06-17 17:29:54 +0300
commite7fb1caf33a31af9af4a65363289ce29d512a1cf (patch)
tree2546cc99b42b9fe103c0aaa2cd26d4c3a1107965
parentb0757784d7fcacc71beadb7988cdbc16520eb0da (diff)
downloadradiorus-rss-e7fb1caf33a31af9af4a65363289ce29d512a1cf.tar.gz
radiorus-rss-e7fb1caf33a31af9af4a65363289ce29d512a1cf.zip
add readme
-rw-r--r--README.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0f8910a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+# radiorus-rss
+инструмент для создания RSS-лент передач «Радио России»
+
+Этот парсер можно использовать для преобразования страницы передачи на сайте «Радио России» в RSS-ленту подкаста. На сегодняшний день поддерживаются только аудиопередачи, при попытке использовать идентификатор передачи с видеовыпусками лента будет сгенерирована, но в ней не будет выпусков.
+
+## Использование
+Может работать в качестве скрипта (при установленном `Go`) или в скомпилированном виде как приложение.
+
+### Без компиляции
+```
+$ go run main.go [опции]
+```
+
+### Как приложение
+> Необходимо предварительно скомпилировать через `go build`.
+```
+$ radiorus-rss [опции]
+```
+
+### Опции
+```
+-brand XXXXX
+```
+выбор передачи. Здесь `XXXXX` — число, как правило, пятизначное, которое можно получить из URL страницы на сайте «Радио России». Так, страница передачи «Мы очень любим оперу» имеет URL вида `www.radiorus.ru/brand/59798/about` — значит, для этой передачи `XXXXX` — `59798`. По умолчанию используется передача `57083` — «Аэростат» Бориса Гребенщикова.
+
+```
+-path [путь]
+```
+путь, где будет создан файл с RSS-лентой. По умолчанию — текущая директория.
+
+## Применение
+Один из возможных сценариев использования — загрузить скомпилированное приложение на сервер и настроить автоматическое создание RSS-ленты через `cron` (промежутки подобрать сообразно с частотой выхода передачи). Именно так сделана [RSS-лента для передачи «Аэростат»](http://evgenykuznetsov.org/feeds/radiorus-57083.rss) на моём сайте.
+
+## При создании использованы
+(и при компиляции входят в состав приложения):
+* [gorilla/feeds](https://github.com/gorilla/feeds) Copyright © 2013-2018 The Gorilla Feeds Authors
+* [The Go Programming Language](https://golang.org) Copyright © 2009 The Go Authors