]> git.immae.eu Git - github/bastienwirtz/homer.git/commitdiff
Update customservices readme for ping
authorSean Kelly <xconverge@users.noreply.github.com>
Wed, 6 Oct 2021 16:16:17 +0000 (09:16 -0700)
committerGitHub <noreply@github.com>
Wed, 6 Oct 2021 16:16:17 +0000 (09:16 -0700)
Fixes #249

Would be improved with https://github.com/bastienwirtz/homer/pull/255

docs/customservices.md

index 4a023a145fdf8cd3c18cc9b69b516679e34e0f7c..a07e47cdcee68f8315c1e74e13222cfb3433bb56 100644 (file)
@@ -72,4 +72,12 @@ For Paperless you need an API-Key which you have to store at the item in the fie
 
 ## Ping
 
-For Ping you need an API-Key which you have to store at the item in the field `apikey`.
+For Ping you need to set the type to Ping and provide a URL.
+```yaml
+items:
+   - name: "Awesome app"
+     type: Ping
+     logo: "assets/tools/sample.png"
+     subtitle: "Bookmark example" tag: "app" 
+     url: "https://www.reddit.com/r/selfhosted/" 
+```