]> git.immae.eu Git - github/bastienwirtz/homer.git/commitdiff
regroup service documentation
authorBastien Wirtz <bastien.wirtz@gmail.com>
Wed, 14 Jul 2021 13:48:57 +0000 (15:48 +0200)
committerBastien Wirtz <bastien.wirtz@gmail.com>
Wed, 14 Jul 2021 13:48:57 +0000 (15:48 +0200)
README.md
docs/configuration.md
docs/customservices.md

index 945fa1f7192393e737126a5c534c6d44aa366f76..944179877705d1d6f026eb02fad74385e9c5f416 100644 (file)
--- a/README.md
+++ b/README.md
@@ -43,8 +43,8 @@
 - [Features](#features)
 - [Getting started](#getting-started)
 - [Configuration](docs/configuration.md)
+- [Custom services](docs/customservices.md)
 - [Tips & tricks](docs/tips-and-tricks.md)
-- [Roadmap](#roadmap)
 - [Development](docs/development.md)
 
 
@@ -134,9 +134,3 @@ npm run build
 ```
 
 Then your dashboard is ready to use in the `/dist` directory.
-
-
-## Roadmap
-
-- [ ] Add new themes.
-- [ ] Add support for custom service card (add custom feature to some service / app link)
index ce36c51604ac991afd12f9adf70737e120176d54..a472b416d7ed707946b8d615975d96aa64200355 100644 (file)
@@ -167,16 +167,3 @@ In order to easily generate all required icon preset for the PWA to work, a tool
 ```bash
 npx vue-pwa-asset-generator -a {your_512x512_source_png} -o {your_output_folder}
 ```
-
-### Supported services
-
-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.
-
-- PiHole
-- AdGuardHome
-- PaperlessNG
-
-### Additional configuration
-
-#### Paperless
-For Paperless you need an API-Key which you have to store at the item in the field `apikey`.
\ No newline at end of file
index d2deff4aa34670dec5c611cf04e320234f671294..43f45f480734519719b87815c0afd293585243d4 100644 (file)
@@ -1,6 +1,8 @@
 # Custom Services
 
-Here is an overview of all custom services that are available within Homer.
+Some service can use a specific a component that provides some extra features by adding a `type` key to the service yaml
+configuration. Available services are in `src/components/`. Here is an overview of all custom services that are available 
+within Homer.
 
 ## PiHole
 
@@ -39,3 +41,13 @@ apikey: "01234deb70424befb1f4ef6a23456789"
 ```
 The url must be the root url of Radarr/Sonarr application.
 The Radarr/Sonarr API key can be found in Settings > General. It is needed to access the API.
+
+
+## PaperlessNG
+
+For Paperless you need an API-Key which you have to store at the item in the field `apikey`.
+
+
+## Ping
+
+For Paperless you need an API-Key which you have to store at the item in the field `apikey`.