aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorBastien Wirtz <bastien.wirtz@gmail.com>2022-07-11 22:07:15 +0200
committerBastien Wirtz <bastien.wirtz@gmail.com>2022-07-11 22:07:15 +0200
commitce391840e58d04f74ca1d411a4686801fc1a1a70 (patch)
treef4e460cf4348d618a0d5733d0cca19dd9d58463a /docs
parent5609315fe77da5441a9c3dda8d92c0ffe9f1bf17 (diff)
downloadhomer-ce391840e58d04f74ca1d411a4686801fc1a1a70.tar.gz
homer-ce391840e58d04f74ca1d411a4686801fc1a1a70.tar.zst
homer-ce391840e58d04f74ca1d411a4686801fc1a1a70.zip
Documentation update
Diffstat (limited to 'docs')
-rw-r--r--docs/configuration.md27
-rw-r--r--docs/customservices.md6
-rw-r--r--docs/development.md4
3 files changed, 10 insertions, 27 deletions
diff --git a/docs/configuration.md b/docs/configuration.md
index a4da08b..10edf71 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -152,7 +152,7 @@ services:
152 # background: red # optional color for card to set color directly without custom stylesheet 152 # background: red # optional color for card to set color directly without custom stylesheet
153``` 153```
154 154
155View [Custom Services](customservices.md) for details about all available custom services (like PiHole) and how to configure them. 155View **[Custom Services](customservices.md)** for details about all available custom services (like `PiHole`) and how to configure them.
156 156
157If you choose to fetch message information from an endpoint, the output format should be as follows (or you can [custom map fields as shown in tips-and-tricks](./tips-and-tricks.md#mapping-fields)): 157If you choose to fetch message information from an endpoint, the output format should be as follows (or you can [custom map fields as shown in tips-and-tricks](./tips-and-tricks.md#mapping-fields)):
158 158
@@ -180,27 +180,4 @@ You can read the [bulma modifiers page](https://bulma.io/documentation/modifiers
180 180
181## PWA Icons 181## PWA Icons
182 182
183In order to easily generate all required icon preset for the PWA to work, a tool like [vue-pwa-asset-generator](https://www.npmjs.com/package/vue-pwa-asset-generator) can be used: 183See icons documentation [here](https://github.com/bastienwirtz/homer/blob/main/public/assets/icons/README.md).
184
185```bash
186npx vue-pwa-asset-generator -a {your_512x512_source_png} -o {your_output_folder}
187```
188
189## Supported services
190
191Currently 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.
192
193- PiHole
194- AdGuardHome
195- PaperlessNG
196- Mealie
197
198## Additional configuration
199
200### Paperless
201
202For Paperless you need an API-Key which you have to store at the item in the field `apikey`.
203
204### Mealie
205
206First off make sure to remove an existing `subtitle` as it will take precedence if set. Setting `type: "Mealie"` will then show the number of recipes Mealie is keeping organized or the planned meal for today if one is planned. You will have to set an API key in the field `apikey` which can be created in your Mealie installation.
diff --git a/docs/customservices.md b/docs/customservices.md
index efe8ca4..6a54400 100644
--- a/docs/customservices.md
+++ b/docs/customservices.md
@@ -19,6 +19,7 @@ within Homer:
19+ [Emby / Jellyfin](#emby--jellyfin) 19+ [Emby / Jellyfin](#emby--jellyfin)
20+ [Uptime Kuma](#uptime-kuma) 20+ [Uptime Kuma](#uptime-kuma)
21+ [Tautulli](#tautulli) 21+ [Tautulli](#tautulli)
22+ [Mealie](#mealie)
22 23
23If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page. 24If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page.
24 25
@@ -223,3 +224,8 @@ endpoint pointing to Tautulli!
223 type: "Tautulli" 224 type: "Tautulli"
224 apikey: "MY-SUPER-SECRET-API-KEY" 225 apikey: "MY-SUPER-SECRET-API-KEY"
225``` 226```
227
228## Mealie
229
230First off make sure to remove an existing `subtitle` as it will take precedence if set.
231Setting `type: "Mealie"` will then show the number of recipes Mealie is keeping organized or the planned meal for today if one is planned. You will have to set an API key in the field `apikey` which can be created in your Mealie installation.
diff --git a/docs/development.md b/docs/development.md
index a22ae0b..85781a1 100644
--- a/docs/development.md
+++ b/docs/development.md
@@ -5,11 +5,11 @@ If you want to contribute to Homer, please read the [contributing guidelines](ht
5```sh 5```sh
6# Using yarn (recommended) 6# Using yarn (recommended)
7yarn install 7yarn install
8yarn serve 8yarn dev
9 9
10# **OR** Using npm 10# **OR** Using npm
11npm install 11npm install
12npm run serve 12npm run dev
13``` 13```
14 14
15## Custom services 15## Custom services