docs: update README with JSON example for notifications (#828)

* docs: update README with JSON example for notifications - Add JSON example for sending notifications with analytics label in README.md - Remove the documentation check step from the GitHub Actions workflow Signed-off-by: Bo-Yi Wu <[email protected]>
appleboy · Jan 22, 2025 · 1e19b9e · 1e19b9e
1 parent ee73d00
commit 1e19b9e
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 3 deletions.
diff --git a/.github/workflows/testing.yml b/.github/workflows/testing.yml
@@ -16,9 +16,6 @@ jobs:
           go-version-file: go.mod
           check-latest: true
 
-      - name: check documentation
-        run: make embedmd
-
       - name: check golangci-lint
         uses: golangci/golangci-lint-action@v6
         with:

diff --git a/README.md b/README.md
@@ -901,6 +901,24 @@ Send normal notification.
 }
 ```
 
+Label associated with the message's analytics data.
+
+```json
+{
+  "notifications": [
+    {
+      "tokens": ["token_a", "token_b"],
+      "platform": 2,
+      "message": "Hello World Android!",
+      "title": "You got message",
+      "fcm_options": {
+        "analytics_label": "example"
+      }
+    }
+  ]
+}
+```
+
 Add `notification` payload.
 
 ```json