docs: refactor API key handling and update documentation

- Replace `apikey` with `key_path` and `credential` in README.md - Add comments for `key_path` and `credential` in config.go Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
appleboy · Jun 8, 2024 · 5ae0c01 · 5ae0c01
1 parent 9a479ac
commit 5ae0c01
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -140,7 +140,8 @@ api:
 
 android:
   enabled: true
-  apikey: "YOUR_API_KEY"
+  key_path: "" # path to fcm key file
+  credential: "" # fcm credential data
   max_retry: 0 # resend fail notification, default value zero is disabled
 
 huawei:

diff --git a/config/config.go b/config/config.go
@@ -57,8 +57,8 @@ api:
 
 android:
   enabled: true
-  key_path: ""
-  credential: ""
+  key_path: "" # path to fcm key file
+  credential: "" # fcm credential data
   max_retry: 0 # resend fail notification, default value zero is disabled
 
 huawei: