From: Sean Kelly <xconverge@users.noreply.github.com>
Date: Wed, 6 Oct 2021 16:16:17 +0000 (-0700)
Subject: Update customservices readme for ping
X-Git-Tag: v22.02.1~29^2~1
X-Git-Url: https://git.immae.eu/?a=commitdiff_plain;h=e58461ffe38cf38b6931f28d406e00daa8f7cd33;p=github%2Fbastienwirtz%2Fhomer.git

Update customservices readme for ping

Fixes #249

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

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
 
 ## 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/" 
+```