diff --git a/LICENSE b/LICENSE index 689f77c..1d3c91d 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2019 Piotr Machowski +Copyright (c) 2022 Piotr Machowski Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index ede0127..6082cf8 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,27 @@ +[![HACS Default][hacs_shield]][hacs] +[![GitHub Latest Release][releases_shield]][latest_release] +[![GitHub All Releases][downloads_total_shield]][releases] +[![Buy me a coffee][buy_me_a_coffee_shield]][buy_me_a_coffee] +[![PayPal.Me][paypal_me_shield]][paypal_me] + + +[hacs_shield]: https://img.shields.io/static/v1.svg?label=HACS&message=Default&style=popout&color=green&labelColor=41bdf5&logo=HomeAssistantCommunityStore&logoColor=white +[hacs]: https://hacs.xyz/docs/default_repositories + +[latest_release]: https://github.com/PiotrMachowski/Home-Assistant-custom-components-Rozkladzik/releases/latest +[releases_shield]: https://img.shields.io/github/release/PiotrMachowski/Home-Assistant-custom-components-Rozkladzik.svg?style=popout + +[releases]: https://github.com/PiotrMachowski/Home-Assistant-custom-components-Rozkladzik/releases +[downloads_total_shield]: https://img.shields.io/github/downloads/PiotrMachowski/Home-Assistant-custom-components-Rozkladzik/total + +[buy_me_a_coffee_shield]: https://img.shields.io/static/v1.svg?label=%20&message=Buy%20me%20a%20coffee&color=6f4e37&logo=buy%20me%20a%20coffee&logoColor=white +[buy_me_a_coffee]: https://www.buymeacoffee.com/PiotrMachowski + +[paypal_me_shield]: https://img.shields.io/static/v1.svg?label=%20&message=PayPal.Me&logo=paypal +[paypal_me]: https://paypal.me/PiMachowski + # Rozkładzik sensor -[![hacs_badge](https://img.shields.io/badge/HACS-Default-orange.svg)](https://github.com/custom-components/hacs) -[![buymeacoffee_badge](https://img.shields.io/badge/Donate-Buy%20Me%20a%20Coffee-ff813f?style=flat)](https://www.buymeacoffee.com/PiotrMachowski) -[![paypalme_badge](https://img.shields.io/badge/Donate-PayPal-0070ba?style=flat)](https://paypal.me/PiMachowski) - This sensor uses unofficial API to get data from [*Rozkładzik.pl*](https://www.rozkladzik.pl) and provide information about departures for chosen stop. ## Configuration options @@ -44,12 +62,20 @@ sensor: ## Installation -Download [*sensor.py*](https://github.com/PiotrMachowski/Home-Assistant-custom-components-Rozkladzik/raw/master/custom_components/rozkladzik/sensor.py) and [*manifest.json*](https://github.com/PiotrMachowski/Home-Assistant-custom-components-Rozkladzik/raw/master/custom_components/rozkladzik/manifest.json) to `config/custom_components/rozkladzik` directory: +### Using [HACS](https://hacs.xyz/) (recommended) + +This integration can be installed using HACS. +To do it search for `Rozkładzik` in *Integrations* section. + +### Manual + +To install this integration manually you have to download [*rozkladzik.zip*](https://github.com/PiotrMachowski/Home-Assistant-custom-components-Rozkladzik/releases/latest/download/rozkladzik.zip) and extract its contents to `config/custom_components/rozkladzik` directory: ```bash mkdir -p custom_components/rozkladzik cd custom_components/rozkladzik -wget https://github.com/PiotrMachowski/Home-Assistant-custom-components-Rozkladzik/raw/master/custom_components/rozkladzik/sensor.py -wget https://github.com/PiotrMachowski/Home-Assistant-custom-components-Rozkladzik/raw/master/custom_components/rozkladzik/manifest.json +wget https://github.com/PiotrMachowski/Home-Assistant-custom-components-Rozkladzik/releases/latest/download/rozkladzik.zip +unzip rozkladzik.zip +rm rozkladzik.zip ``` @@ -91,3 +117,4 @@ wget https://github.com/PiotrMachowski/Home-Assistant-custom-components-Rozkladz - Value for `id` comes from query parameter `t` or `b` for group mode. Buy Me A Coffee +PayPal Logo diff --git a/custom_components/rozkladzik/__init__.py b/custom_components/rozkladzik/__init__.py new file mode 100644 index 0000000..03065dc --- /dev/null +++ b/custom_components/rozkladzik/__init__.py @@ -0,0 +1 @@ +"""Rozkładzik""" \ No newline at end of file diff --git a/custom_components/rozkladzik/manifest.json b/custom_components/rozkladzik/manifest.json index 9753e29..a75b4c3 100644 --- a/custom_components/rozkladzik/manifest.json +++ b/custom_components/rozkladzik/manifest.json @@ -2,8 +2,10 @@ "domain": "rozkladzik", "name": "Rozkładzik", "documentation": "https://github.com/PiotrMachowski/Home-Assistant-custom-components-Rozkladzik", + "issue_tracker": "https://github.com/PiotrMachowski/Home-Assistant-custom-components-Rozkladzik/issues", "dependencies": [], "codeowners": ["@PiotrMachowski"], "requirements": ["requests"], - "version": "v1.1.4" + "version": "v1.1.5", + "iot_class": "cloud_polling" } \ No newline at end of file