Skip to content

Commit e4c3d9a

Browse files
committed
Add initial README and YAML linting configuration files
1 parent 7bb105e commit e4c3d9a

File tree

2 files changed

+142
-0
lines changed

2 files changed

+142
-0
lines changed

.README.j2

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Staerk Home Assistant Add-ons
2+
3+
[![License][license-shield]][license]
4+
5+
## About
6+
7+
Home Assistant add-ons repository by Jeppe Stærk. These add-ons extend the functionality of your Home Assistant installation.
8+
9+
## Installation
10+
11+
Click the button below to add this repository to your Home Assistant instance:
12+
13+
[![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={{ repo | safe}})
14+
15+
Or use the following URL to add this repository:
16+
17+
```txt
18+
{{ repo }}
19+
```
20+
21+
## Add-ons
22+
23+
{% for addon in addons %}
24+
### ✓ [{{ addon.name }}][addon-{{ addon.target }}]
25+
26+
![Latest Version][{{ addon.target }}-version-shield]
27+
![Supports armhf Architecture][{{ addon.target }}-armhf-shield]
28+
![Supports armv7 Architecture][{{ addon.target }}-armv7-shield]
29+
![Supports aarch64 Architecture][{{ addon.target }}-aarch64-shield]
30+
![Supports amd64 Architecture][{{ addon.target }}-amd64-shield]
31+
![Supports i386 Architecture][{{ addon.target }}-i386-shield]
32+
33+
{{ addon.description }}
34+
35+
[:books: {{ addon.name }} add-on documentation][addon-doc-{{ addon.target }}]
36+
37+
{% endfor %}
38+
39+
## Support
40+
41+
Got questions?
42+
43+
- Create an issue on GitHub for bug reports, feature requests, or questions
44+
- Add a ⭐️ [star on GitHub]({{ repo }}) to support the project
45+
46+
## Acknowledgments
47+
48+
Special thanks to [Franck Nijhof][frenck] and the [Home Assistant Community Add-ons][ha-addons] project for their invaluable work. This add-on heavily relies on their foundation:
49+
50+
- Base container images
51+
- CI, workflows and best practices
52+
- Readme and docs templates
53+
54+
Their open-source contributions make add-ons like this possible.
55+
56+
## License
57+
58+
MIT License - Copyright (c) 2025 Jeppe Stærk
59+
60+
{% for addon in addons %}
61+
[addon-{{ addon.target }}]: {{ addon.repo }}/tree/{{ addon.version }}
62+
[addon-doc-{{ addon.target}}]: {{ addon.repo }}/blob/{{ addon.version }}/README.md
63+
[{{ addon.target }}-issue]: {{ addon.repo }}/issues
64+
[{{ addon.target }}-version-shield]: https://img.shields.io/badge/version-{{ addon.version }}-blue.svg
65+
{% for arch in ['aarch64', 'amd64', 'armhf', 'armv7', 'i386'] %}
66+
{% if arch in addon.archs %}
67+
[{{ addon.target }}-{{ arch }}-shield]: https://img.shields.io/badge/{{ arch }}-yes-green.svg
68+
{% else %}
69+
[{{ addon.target }}-{{ arch }}-shield]: https://img.shields.io/badge/{{ arch }}-no-red.svg
70+
{% endif %}
71+
{% endfor %}
72+
{% endfor %}
73+
[license]: https://github.com/staerk-ha-addons/repository/blob/main/LICENSE
74+
[license-shield]: https://img.shields.io/github/license/staerk-ha-addons/repository.svg

.yamllint

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
ignore: |
3+
*/translations/*.yaml
4+
*/config.yaml
5+
*/config.yml
6+
rules:
7+
braces:
8+
level: error
9+
min-spaces-inside: 0
10+
max-spaces-inside: 1
11+
min-spaces-inside-empty: -1
12+
max-spaces-inside-empty: -1
13+
brackets:
14+
level: error
15+
min-spaces-inside: 0
16+
max-spaces-inside: 0
17+
min-spaces-inside-empty: -1
18+
max-spaces-inside-empty: -1
19+
colons:
20+
level: error
21+
max-spaces-before: 0
22+
max-spaces-after: 1
23+
commas:
24+
level: error
25+
max-spaces-before: 0
26+
min-spaces-after: 1
27+
max-spaces-after: 1
28+
comments:
29+
level: error
30+
require-starting-space: true
31+
min-spaces-from-content: 2
32+
comments-indentation:
33+
level: error
34+
document-end:
35+
level: error
36+
present: false
37+
document-start:
38+
level: error
39+
present: true
40+
empty-lines:
41+
level: error
42+
max: 1
43+
max-start: 0
44+
max-end: 1
45+
hyphens:
46+
level: error
47+
max-spaces-after: 1
48+
indentation:
49+
level: error
50+
spaces: 2
51+
indent-sequences: true
52+
check-multi-line-strings: false
53+
key-duplicates:
54+
level: error
55+
line-length:
56+
level: warning
57+
max: 120
58+
allow-non-breakable-words: true
59+
allow-non-breakable-inline-mappings: true
60+
new-line-at-end-of-file:
61+
level: error
62+
new-lines:
63+
level: error
64+
type: unix
65+
trailing-spaces:
66+
level: error
67+
truthy:
68+
level: error

0 commit comments

Comments
 (0)