Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
PiotrMachowski committed Jan 23, 2022
1 parent c4af1e1 commit 219f389
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 15 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2020 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
Expand Down
37 changes: 26 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,24 @@
[![hacs_badge](https://img.shields.io/badge/HACS-Custom-orange.svg)](https://hacs.xyz/docs/faq/custom_repositories)
[![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)
![GitHub All Releases](https://img.shields.io/github/downloads/PiotrMachowski/Home-Assistant-custom-components-Dom-5/total)
[![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/default_repositories

[latest_release]: https://github.com/PiotrMachowski/Home-Assistant-custom-components-Dom-5/releases/latest
[releases_shield]: https://img.shields.io/github/release/PiotrMachowski/Home-Assistant-custom-components-Dom-5.svg?style=popout

[releases]: https://github.com/PiotrMachowski/Home-Assistant-custom-components-Dom-5/releases
[downloads_total_shield]: https://img.shields.io/github/downloads/PiotrMachowski/Home-Assistant-custom-components-Dom-5/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

# Dom 5 Sensor

Expand All @@ -19,7 +36,7 @@ After adding a custom repository you can use HACS to install this integration us

### Manual

To install this integration manually you have to download [*dom_5.zip*](https://github.com/PiotrMachowski/Home-Assistant-custom-components-Dom-5/releases/latest/download/dom_5.zip) extract its contents to `config/custom_components/dom_5` directory:
To install this integration manually you have to download [*dom_5.zip*](https://github.com/PiotrMachowski/Home-Assistant-custom-components-Dom-5/releases/latest/download/dom_5.zip) and extract its contents to `config/custom_components/dom_5` directory:
```bash
mkdir -p custom_components/dom_5
cd custom_components/dom_5
Expand Down Expand Up @@ -72,12 +89,10 @@ content: |-
{{ state_attr('sensor.dom_5_last_message_' + username, 'body') }}
---
# Finances
**Balance:** {{ "%.2f zł" | format(states('sensor.dom_5_finances_' + username)
| float) }}
**Arrear:** {{ "%.2f zł" | format(state_attr('sensor.dom_5_finances_' +
username, 'arrear') | float) }}
**Overpayment:** {{ "%.2f zł" | format(state_attr('sensor.dom_5_finances_' +
username, 'overpayment') | float) }}
**Balance:** {{ "%.2f zł" | format(states('sensor.dom_5_finances_' + username) | float) }}
**Arrear:** {{ "%.2f zł" | format(state_attr('sensor.dom_5_finances_' + username, 'arrear') | float) }}
**Overpayment:** {{ "%.2f zł" | format(state_attr('sensor.dom_5_finances_' + username, 'overpayment') | float) }}
```
<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>
5 changes: 3 additions & 2 deletions custom_components/dom_5/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
"dependencies": [],
"codeowners": ["@PiotrMachowski"],
"requirements": ["requests", "html2text"],
"version": "v1.0.1",
"config_flow": true
"version": "v1.0.2",
"config_flow": true,
"iot_class": "cloud_polling"
}
2 changes: 1 addition & 1 deletion custom_components/dom_5/translations/en.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"title" : "Dom 5",
"title": "Dom 5",
"config": {
"abort": {
"already_configured": "[This integration is already configured]"
Expand Down

0 comments on commit 219f389

Please # to comment.