Skip to content

Commit

Permalink
Update readme's
Browse files Browse the repository at this point in the history
  • Loading branch information
r57zone committed May 9, 2018
1 parent e5178ba commit 4f7b696
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
5 changes: 3 additions & 2 deletions README.EN.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[![RU](https://user-images.githubusercontent.com/9499881/27683795-5b0fbac6-5cd8-11e7-929c-057833e01fb1.png)](https://github.com/r57zone/RSS-checker/blob/master/README.md)
[![EN](https://user-images.githubusercontent.com/9499881/33184537-7be87e86-d096-11e7-89bb-f3286f752bc6.png)](https://github.com/r57zone/RSS-checker/blob/master/README.EN.md)
# RSS checker
Notification of a new event published in RSS. For example, can set up a notification for the release of a new series of the tv show.
Notification of a new event published in RSS. For example, can set up a notification for the release of a new series of the tv show and download torrent.

## Setup
1. [Download notification app](https://github.com/r57zone/notifications) and extract him to folder "C:\Program Files\Notification".<br>
Expand All @@ -13,7 +13,8 @@ Notification of a new event published in RSS. For example, can set up a notifica
## Filters
The search is based on the search attribute, for example, search="The Americans". In this case, the name "The Americans" will be searched for in the RSS feed event.<br>
Ignoring occurs on the ignore attribute, for example, ignore="720p;1080p;". In this case, the names with the lines "720p" and "1080p" will be ignored.<br>
The value of the "name" parameter is required for the notification application.
The value of the "name" parameter is required for the notification application.<br>
The parameter "download" is responsible for downloading torrents (false - no and true - yes). If necessary, you can add cookies for RSS feeds, the parameter "cookie". To automatically add a torrent to the boot program, you must change the "DownloaderPath" parameter in the "Setup.ini" file.

## Notification
The RSS element contains the "notification" attribute, which will be displayed in the notification of the new event. You can also add icons to the notification by adding images to the "Icons" folder of the notification program and changing the attributes big-icon="1.png" and small-icon="2.png" by writing the image names in them. A large icon has a size of 90 by 90 pixels, and a small one is 30 by 30, you can read more [here](https://github.com/r57zone/notifications).
Expand Down
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[![RU](https://user-images.githubusercontent.com/9499881/27683795-5b0fbac6-5cd8-11e7-929c-057833e01fb1.png)](https://github.com/r57zone/RSS-checker/blob/master/README.md)
[![EN](https://user-images.githubusercontent.com/9499881/33184537-7be87e86-d096-11e7-89bb-f3286f752bc6.png)](https://github.com/r57zone/RSS-checker/blob/master/README.EN.md)
# RSS checker
Уведомление о новом событии, публикуемом в RSS. Например, можно настроить уведомление на выход новой серии сериала.
Уведомление о новом событии, публикуемом в RSS. Например, можно настроить уведомление на выход новой серии сериала и загрузить торрент.

## Настройка
1. [Загрузите программу уведомлений](https://github.com/r57zone/notifications) и распакуйте её, например, в папку "C:\Program Files\Notification".<br>
Expand All @@ -14,7 +14,8 @@
## Фильтры
Поиск происходит по атрибуту search, например, search="The Americans". В этом случае в событии RSS ленты будет искаться название "The Americans". Искать названия лучше на латинице, чтобы не было проблем с кодировками.<br>
Игнорирование происходит по атрибуту ignore, например, ignore="720p;1080p;". В этом случае будут игнорироваться названия со строками "720p" и "1080p".<br>
Значение параметра "name" необходимо для приложения уведомлений.
Значение параметра "name" необходимо для приложения уведомлений.<br>
Параметр "download" отвечает за загрузку торрентов (false - нет и true - да). При необходимости можно добавить куки для RSS ленты, параметр "cookie". Для автоматического добавления торрента в программу загрузки необходимо изменить параметр "DownloaderPath" в файле "Setup.ini".

## Уведомление
Элемент RSS содержит атрибут "notification", который будет отображаться в уведомлении о новом событии. Также можно добавить иконки в уведомление, для этого необходимо добавить изображения в папку "Icons" программы уведомлений и изменить атрибуты big-icon="1.png" и small-icon="2.png", написав в них названия изображений. Большая иконка имеет размер 90 на 90 пикселей, а маленькая 30 на 30, более подробно можно прочитать [тут](https://github.com/r57zone/notifications).
Expand Down

0 comments on commit 4f7b696

Please sign in to comment.