diff options
author | Sean Kelly <xconverge@users.noreply.github.com> | 2021-10-06 09:16:17 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-10-06 09:16:17 -0700 |
commit | e58461ffe38cf38b6931f28d406e00daa8f7cd33 (patch) | |
tree | b33676a5c71a1d4353430ead308fdfc9d6cd38d1 | |
parent | 451b1ac62450fb2c4f8e2382bcf422bb7a434700 (diff) | |
download | homer-e58461ffe38cf38b6931f28d406e00daa8f7cd33.tar.gz homer-e58461ffe38cf38b6931f28d406e00daa8f7cd33.tar.zst homer-e58461ffe38cf38b6931f28d406e00daa8f7cd33.zip |
Update customservices readme for ping
Fixes #249
Would be improved with https://github.com/bastienwirtz/homer/pull/255
-rw-r--r-- | docs/customservices.md | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/docs/customservices.md b/docs/customservices.md index 4a023a1..a07e47c 100644 --- a/docs/customservices.md +++ b/docs/customservices.md | |||
@@ -72,4 +72,12 @@ For Paperless you need an API-Key which you have to store at the item in the fie | |||
72 | 72 | ||
73 | ## Ping | 73 | ## Ping |
74 | 74 | ||
75 | For Ping you need an API-Key which you have to store at the item in the field `apikey`. | 75 | For Ping you need to set the type to Ping and provide a URL. |
76 | ```yaml | ||
77 | items: | ||
78 | - name: "Awesome app" | ||
79 | type: Ping | ||
80 | logo: "assets/tools/sample.png" | ||
81 | subtitle: "Bookmark example" tag: "app" | ||
82 | url: "https://www.reddit.com/r/selfhosted/" | ||
83 | ``` | ||