diff --git a/README.md b/README.md new file mode 100644 index 0000000..3f47507 --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +# ankermgmt hassio addons repository +## Installation + +[![Add repository on my Home Assistant][repository-badge]][repository-url] + +If you want to do add the repository manually, please follow the procedure highlighted in the [Home Assistant website](https://home-assistant.io/hassio/installing_third_party_addons). Use the following URL to add this repository: https://github.com/ankermgmt/ankermgmt-hassio-addons + +## Add-on provided by this repository + +✓ [ankerctl](ankerctl/) : Monitor your AnkerMake printer + +  ![Version](https://img.shields.io/badge/dynamic/yaml?label=Version&query=%24.version&url=https%3A%2F%2Fraw.githubusercontent.com%2Fankermgmt%2Fankermgmt-hassio-addons%2Fmaster%2Fankerctl%2Fconfig.yaml) +![aarch64][aarch64-badge] +![amd64][amd64-badge] +![armv7][armv7-badge] + +## Support + +Got questions? + +You have several options to get them answered: + +- The Home Assistant [Community Forum][forum]. +- This repository issues list + +[aarch64-badge]: https://img.shields.io/badge/aarch64--green.svg?logo=arm +[amd64-badge]: https://img.shields.io/badge/amd64--green.svg?logo=amd +[armv7-badge]: https://img.shields.io/badge/armv7--green.svg?logo=arm +[aarch64no-badge]: https://img.shields.io/badge/aarch64--orange.svg?logo=arm +[amd64no-badge]: https://img.shields.io/badge/amd64--orange.svg?logo=amd +[armv7no-badge]: https://img.shields.io/badge/armv7--orange.svg?logo=arm +[forum]: https://community.home-assistant.io/t/my-custom-repo +[repository-badge]: https://img.shields.io/badge/Add%20repository%20to%20my-Home%20Assistant-41BDF5?logo=home-assistant&style=for-the-badge +[repository-url]: https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fankermgmt%2Fankermgmt-hassio-addons \ No newline at end of file diff --git a/ankerctl/README.md b/ankerctl/README.md new file mode 100644 index 0000000..a15287a --- /dev/null +++ b/ankerctl/README.md @@ -0,0 +1,26 @@ +# Home assistant add-on: ankerctl +![Arch](https://img.shields.io/badge/dynamic/yaml?color=success&label=Arch&query=%24.arch&url=https%3A%2F%2Fraw.githubusercontent.com%2Fankermgmt%2Fankermgmt-hassio-addons%2Fmaster%2Fankerctl%2Fconfig.yaml) + +## About +--- +[ankerctl](https://github.com/Ankermgmt/ankermake-m5-protocol) provides a web UI for monitoring your AnkerMake 3D printer. +This addon is based on the docker image provided in https://github.com/Ankermgmt/ankermake-m5-protocol + +## Installation +--- +The installation of this add-on is pretty straightforward and not different in comparison to installing any other add-on. + +1. Add this add-ons repository to your Home Assistant instance + [![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fankermgmt%2Fankermgmt-hassio-addons) +2. Install this add-on. +3. Start the add-on. +4. Check the logs of the add-on to see if everything went well. +5. Open the webUI and upload your login.json (see the webUI or [ankerctl](https://github.com/Ankermgmt/ankermake-m5-protocol) for more information.) + +## Configuration +--- +WebUI can be found at (default port is 4470). + +## Support +--- +Create an issue on github \ No newline at end of file