Skip to content

Commit

Permalink
Docs and side polishing
Browse files Browse the repository at this point in the history
Signed-off-by: Arnaud Quette <[email protected]>
  • Loading branch information
arnaudquette-eaton committed Dec 16, 2023
1 parent e78c9c8 commit a817cea
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 216 deletions.
201 changes: 0 additions & 201 deletions LICENSE

This file was deleted.

24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,9 @@ As a result, many NUT limitations can be removed, to focus on drivers and event
A Network UPS Tools daemon to allow you to easily manage battery backup (UPS)
devices connected to your Home Assistant machine.

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
<!--
Example doc: https://github.com/zigbee2mqtt/hassio-zigbee2mqtt
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-->

## About

Expand Down Expand Up @@ -149,28 +149,28 @@ our [GitHub Repository][repository].
[armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg
[buymeacoffee]: https://www.buymeacoffee.com/arnaudqueto
[commits-shield]: https://img.shields.io/github/commit-activity/y/hassio-addons/addon-nut.svg
[commits]: https://github.com/hassio-addons/addon-nut/commits/main
[contributors]: https://github.com/hassio-addons/addon-nut/graphs/contributors
[commits-shield]: https://img.shields.io/github/commit-activity/y/aquette/addon-smartnut.svg
[commits]: https://github.com/aquette/addon-smartnut/commits/main
[contributors]: https://github.com/aquette/addon-smartnut/graphs/contributors
[aquette]: https://github.com/aquette
[discord-ha]: https://discord.gg/c5DvZ4e
[discord-shield]: https://img.shields.io/discord/478094546522079232.svg
[discord]: https://discord.me/hassioaddons
[docs]: https://github.com/hassio-addons/addon-nut/blob/main/nut/DOCS.md
[docs]: https://github.com/aquette/addon-smartnut/blob/main/nut/DOCS.md
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
[forum]: https://community.home-assistant.io/t/community-hass-io-add-on-network-ups-tools/68516
[github-actions-shield]: https://github.com/hassio-addons/addon-nut/workflows/CI/badge.svg
[github-actions]: https://github.com/hassio-addons/addon-nut/actions
[github-actions-shield]: https://github.com/aquette/addon-smartnut/workflows/CI/badge.svg
[github-actions]: https://github.com/aquette/addon-smartnut/actions
[i386-shield]: https://img.shields.io/badge/i386-no-red.svg
[issue]: https://github.com/hassio-addons/addon-nut/issues
[license-shield]: https://img.shields.io/github/license/hassio-addons/addon-nut.svg
[issue]: https://github.com/aquette/addon-smartnut/issues
[license-shield]: https://img.shields.io/github/license/aquette/addon-smartnut.svg
[maintenance-shield]: https://img.shields.io/maintenance/yes/2023.svg
[nut-acknowledgements]: https://networkupstools.org/acknowledgements.html
[nut-compatible]: https://networkupstools.org/stable-hcl.html
[nut-features]: https://networkupstools.org/features.html
[nut-ha-docs]: https://www.home-assistant.io/integrations/nut/
[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg
[reddit]: https://reddit.com/r/homeassistant
[releases-shield]: https://img.shields.io/github/release/hassio-addons/addon-nut.svg
[releases]: https://github.com/hassio-addons/addon-nut/releases
[releases-shield]: https://img.shields.io/github/release/aquette/addon-smartnut.svg
[releases]: https://github.com/aquette/addon-smartnut/releases
[repository]: https://github.com/hassio-addons/repository
8 changes: 5 additions & 3 deletions smartnut/DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ many [individuals and companies][nut-acknowledgements].

## Installation

| :exclamation: This is an early development version! You need to enable Advanced mode + HACS |
|----------------------------------------------------------------------------------------------|
| :exclamation: This is an early development version! You need to enable Advanced mode + HACS... at your own risk ;) |
|---------------------------------------------------------------------------------------------------------------------|

The installation of this add-on is pretty straightforward and not different in
comparison to installing any other Home Assistant add-on.
Expand Down Expand Up @@ -79,6 +79,7 @@ FIXME
The add-on can be used with the basic configuration, with other options for more
advanced users.

<!-->
**Note**: _Remember to restart the add-on when the configuration is changed._

SmartNUT add-on configuration:
Expand Down Expand Up @@ -339,6 +340,7 @@ automations:

For more information, see the NUT docs [here][nut-notif-doc-1] and
[here][nut-notif-doc-2].
-->

## Changelog & Releases

Expand Down Expand Up @@ -372,7 +374,7 @@ You could also [open an issue here][issue] GitHub.

The original setup of this repository is by [Arnaud Quette][aquette].

[Arnaud Quette][aquette] is the former NUT project leader, main developer, Debian packager, author of many drivers (usbhid-ups, snmp-ups, dummy-ups, ...), WMNUT and lot more (...)
[Arnaud Quette][aquette] is the retired former NUT project leader, and its main developer / Debian packager / author of many drivers (usbhid-ups, snmp-ups, dummy-ups, ...) / author of WMNUT and lot more (...)

For a full list of all authors and contributors,
check [the contributor's page][contributors].
Expand Down

0 comments on commit a817cea

Please sign in to comment.