diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..518b460c --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2017 Paramtamtam + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 00000000..0e486232 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# MikroTik hosts parser + +[![styleci](https://styleci.io/repos/39877790/shield)](https://styleci.io/repos/39877790) [![Build Status](https://scrutinizer-ci.com/g/tarampampam/mikrotik-hosts-parser/badges/build.png?b=master)](https://scrutinizer-ci.com/g/tarampampam/mikrotik-hosts-parser/build-status/master) [![Code Coverage](https://scrutinizer-ci.com/g/tarampampam/mikrotik-hosts-parser/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/tarampampam/mikrotik-hosts-parser/?branch=master) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/tarampampam/mikrotik-hosts-parser/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/tarampampam/mikrotik-hosts-parser/?branch=master) [![GitHub issues](https://img.shields.io/github/issues/tarampampam/mikrotik-hosts-parser.svg?style=flat-square)](https://github.com/tarampampam/mikrotik-hosts-parser/issues) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://raw.githubusercontent.com/tarampampam/mikrotik-hosts-parser/master/LICENSE) + +Приложение, которое генерирует скрипт для роутера на базе `RouterOS`, который блокирует "рекламные" хосты. + +Более подробно о нем можно прочитать по [этой ссылке (хабр)][habr]. + +### Установка + +Для развертывания приложения достаточно выполнить в терминале: + +```bash +$ composer create-project tarampampam/mikrotik-hosts-parser +``` + +Все интересные настройки вынесены в файлы конфигурации, что лежат в директории `./config`: + +### Демо + +Не гарантирую что приложение будет жить вечно, что пользоваться им можешь [тут][demo]. + +### Лицензия + +[MIT license](./LICENSE) *(да делай ты что хочешь, просто не удаляй имя автора)*. + +[demo]: https://stopad.kplus.pro/ +[habr]: https://habrahabr.ru/post/264001/