Skip to content

Commit 92d899b

Browse files
committed
regroup service documentation
1 parent c06c0cd commit 92d899b

File tree

3 files changed

+14
-21
lines changed

3 files changed

+14
-21
lines changed

README.md

+1-7
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@
4343
- [Features](#features)
4444
- [Getting started](#getting-started)
4545
- [Configuration](docs/configuration.md)
46+
- [Custom services](docs/customservices.md)
4647
- [Tips & tricks](docs/tips-and-tricks.md)
47-
- [Roadmap](#roadmap)
4848
- [Development](docs/development.md)
4949

5050

@@ -134,9 +134,3 @@ npm run build
134134
```
135135

136136
Then your dashboard is ready to use in the `/dist` directory.
137-
138-
139-
## Roadmap
140-
141-
- [ ] Add new themes.
142-
- [ ] Add support for custom service card (add custom feature to some service / app link)

docs/configuration.md

-13
Original file line numberDiff line numberDiff line change
@@ -167,16 +167,3 @@ In order to easily generate all required icon preset for the PWA to work, a tool
167167
```bash
168168
npx vue-pwa-asset-generator -a {your_512x512_source_png} -o {your_output_folder}
169169
```
170-
171-
### Supported services
172-
173-
Currently the following services are supported for showing quick infos on the card. They can be used by setting the type to one of the following values at the item.
174-
175-
- PiHole
176-
- AdGuardHome
177-
- PaperlessNG
178-
179-
### Additional configuration
180-
181-
#### Paperless
182-
For Paperless you need an API-Key which you have to store at the item in the field `apikey`.

docs/customservices.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Custom Services
22

3-
Here is an overview of all custom services that are available within Homer.
3+
Some service can use a specific a component that provides some extra features by adding a `type` key to the service yaml
4+
configuration. Available services are in `src/components/`. Here is an overview of all custom services that are available
5+
within Homer.
46

57
## PiHole
68

@@ -39,3 +41,13 @@ apikey: "01234deb70424befb1f4ef6a23456789"
3941
```
4042
The url must be the root url of Radarr/Sonarr application.
4143
The Radarr/Sonarr API key can be found in Settings > General. It is needed to access the API.
44+
45+
46+
## PaperlessNG
47+
48+
For Paperless you need an API-Key which you have to store at the item in the field `apikey`.
49+
50+
51+
## Ping
52+
53+
For Paperless you need an API-Key which you have to store at the item in the field `apikey`.

0 commit comments

Comments
 (0)