Skip to content

Commit c1c55f5

Browse files
committed
Update README.md
1 parent fd5d7cb commit c1c55f5

File tree

1 file changed

+59
-11
lines changed

1 file changed

+59
-11
lines changed

README.md

Lines changed: 59 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,69 @@
77
[![hassfest](https://github.com/DSorlov/swemail/workflows/Validate%20with%20hassfest/badge.svg)](https://github.com/DSorlov/swemail/actions/workflows/hassfest.yaml)
88
[![HACS](https://github.com/DSorlov/swemail/workflows/HACS%20Validation/badge.svg)](https://github.com/DSorlov/swemail/actions/workflows/hacs.yaml)
99
[![maintainer](https://img.shields.io/badge/maintainer-dsorlov-blue.svg)](https://github.com/DSorlov)
10-
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
10+
[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
1111

1212
Svensk Postutdelning / Swedish Mail Delivery
1313
============================================
1414

15-
A small and simple integration to provide information about delivery days for Postnord and Citymail in any swedish postal code.
15+
A small integration to provide information about delivery days for Postnord and Citymail in any swedish postal code as defined by Postnord and Citymail. The integration will create a sensor for each postal code, and also separate sensors for Postnord and/or Citymail as specified. The common sensor will show the next delivery date regardless of operator.
1616

17-
## Install using HACS
17+
## Installation
1818

19-
* If you haven't already you must have [HACS installed](https://hacs.xyz/docs/setup/download).
20-
* Go into HACS and search for Svensk Postutdelning under the Integrations headline. Install it. You will need to restart Home Assistant to finish the process.
21-
* Once that is done, try to reload your GUI (caching issues could prevent the integration to be shown).
22-
* Goto Integrations and add Svensk Postutdelning or Swedish Mail Delivery (depending on language)
23-
* Enter postal code and select your providers
24-
* Sensors are created and updated. Enjoy!
25-
- One sensor for each selected provider
26-
- An additional combined sensor regardless of provider
19+
### HACS (Recommended)
2720

21+
1. Open HACS in Home Assistant
22+
2. Go to "Integrations"
23+
3. Click the "+" button
24+
4. Search for "Svensk Postutdelning"
25+
5. Install the integration
26+
6. Restart Home Assistant
27+
28+
### Manual Installation
29+
30+
1. Download the latest release from [GitHub](https://github.com/dsorlov/swemail/releases)
31+
2. Extract the `custom_components/swemail` folder to your Home Assistant's `custom_components` directory
32+
3. Restart Home Assistant
33+
34+
## Configuration
35+
36+
### Via UI (Recommended)
37+
38+
1. Go to **Settings****Devices & Services**
39+
2. Click **Add Integration**
40+
3. Search for "Svensk Postutdelning"
41+
4. Follow the configuration steps.
42+
43+
## Localization
44+
45+
I have tried to use machine translation to create a few useable translations. Please correct me if there are any major wrongs or you are missing some languages:
46+
47+
- :uk: English (en.json) - English
48+
- :sweden: Swedish (sv.json) - Svenska
49+
- :iceland: Icelandic (is.json) - Íslenska
50+
- :denmark: Danish (da.json) - Dansk
51+
- :norway: Norwegian (no.json) - Norsk
52+
- :finland: Finnish (fi.json) - Suomi
53+
- :es: Spanish (es.json) - Español
54+
- :tr: Turkish (tr.json) - Türkçe
55+
- :saudi_arabia: Arabic (ar.json) - العربية
56+
- :ukraine: Ukrainian (uk.json) - Українська
57+
- :fr: French (fr.json) - Français
58+
59+
## Contributing
60+
61+
Contributions are welcome! Please feel free to submit a Pull Request.
62+
63+
## License
64+
65+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
66+
67+
## Support
68+
69+
- :bug: [Report a Bug](https://github.com/dsorlov/snmpPrinter/issues)
70+
- :bulb: [Request a Feature](https://github.com/dsorlov/snmpPrinter/issues)
71+
- :book: [Documentation](https://github.com/dsorlov/snmpPrinter)
72+
73+
## Changelog
74+
75+
See [CHANGELOG.md](CHANGELOG.md) for version history.

0 commit comments

Comments
 (0)