Update documentation

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

README.md

@@ -1,15 +1,58 @@
+[![HACS Custom][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=Custom&style=popout&color=orange&labelColor=41bdf5&logo=HomeAssistantCommunityStore&logoColor=white
+[hacs]: https://hacs.xyz/docs/faq/custom_repositories
+
+[latest_release]: https://github.com/PiotrMachowski/Home-Assistant-custom-components-Xiaomi-Vacuum-Map-Camera/releases/latest
+[releases_shield]: https://img.shields.io/github/release/PiotrMachowski/Home-Assistant-custom-components-Xiaomi-Vacuum-Map-Camera.svg?style=popout
+
+[releases]: https://github.com/PiotrMachowski/Home-Assistant-custom-components-Xiaomi-Vacuum-Map-Camera/releases
+[downloads_total_shield]: https://img.shields.io/github/downloads/PiotrMachowski/Home-Assistant-custom-components-Xiaomi-Vacuum-Map-Camera/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
+
 # Xiaomi Vacuum Map Camera
 
 
 **WARNING!**
 
 This version of integration is not fully tested.
 
-### Requirements
+## Requirements
 
 Home Assistant must have ssh access to the vacuum (it must be able to connect via ssh without password authentication)
 
-### Example configuration
+## Installation
+
+### Using [HACS](https://hacs.xyz/) (recommended)
+
+This integration can be added to HACS as a [custom repository](https://hacs.xyz/docs/faq/custom_repositories):
+* URL: `https://github.com/PiotrMachowski/Home-Assistant-custom-components-Xiaomi-Vacuum-Map-Camera`
+* Category: `Integration`
+
+After adding a custom repository you can use HACS to install this integration using user interface.
+
+### Manual
+
+To install this integration manually you have to download [*xiaomi_vacuum_map.zip*](https://github.com/PiotrMachowski/Home-Assistant-custom-components-Xiaomi-Vacuum-Map-Camera/releases/latest/download/xiaomi_vacuum_map.zip) and extract its contents to `config/custom_components/xiaomi_vacuum_map` directory:
+```bash
+mkdir -p custom_components/xiaomi_vacuum_map
+cd custom_components/xiaomi_vacuum_map
+wget https://github.com/PiotrMachowski/Home-Assistant-custom-components-Xiaomi-Vacuum-Map-Camera/releases/latest/download/smartthings_soundbar.zip
+unzip xiaomi_vacuum_map.zip
+rm xiaomi_vacuum_map.zip
+```
+
+## Example configuration
 
 ```yaml
 camera:
@@ -18,6 +61,9 @@ camera:
     vacuum_entity: "vacuum.roborock"
 ```
 
-### Known issues
+## Known issues
 * Errors in logs after start of HA
-* Map not being available until the first run of the vacuum.
+* Map not being available until the first run of the vacuum.
+
+<a href="https://www.buymeacoffee.com/PiotrMachowski" target="_blank"><img src="https://bmc-cdn.nyc3.digitaloceanspaces.com/BMC-button-images/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: auto !important;width: auto !important;" ></a>
+<a href="https://paypal.me/PiMachowski" target="_blank"><img src="https://www.paypalobjects.com/webstatic/mktg/logo/pp_cc_mark_37x23.jpg" border="0" alt="PayPal Logo" style="height: auto !important;width: auto !important;"></a>

custom_components/xiaomi_vacuum_map/manifest.json

@@ -2,8 +2,10 @@
   "domain": "xiaomi_vacuum_map",
   "name": "Xiaomi Vacuum Map",
   "documentation": "https://github.com/PiotrMachowski/Home-Assistant-custom-components-Xiaomi-Vacuum-Map-Camera",
+  "issue_tracker": "https://github.com/PiotrMachowski/Home-Assistant-custom-components-Xiaomi-Vacuum-Map-Camera/issues",
   "dependencies": [],
   "codeowners": ["@PiotrMachowski"],
   "requirements": ["pillow"],
-  "version": "v1.0.0"
+  "version": "v1.0.1",
+  "iot_class": "local_polling"
 }