Add configuration description on readme

elquimeras · May 7, 2021 · b777607 · b777607
1 parent 2e143d5
commit b777607
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -47,3 +47,19 @@ function throwError(detail: any): void {
 }
 
 ```
+
+## Configuration
+
+| Initialization Parameter | Description                                                                                                   |
+| ------------------------ | ------------------------------------------------------------------------------------------------------------- |
+| AppId                    | App ID, which is obtained from app information.                                                               |
+| AppSecret                | Secret access key of an app, which is obtained from app information.                                          |
+| AuthUrl                  | URL for the Huawei OAuth 2.0 service to obtain a token, please refer to Generating an App-Level Access Token. |
+| PushUrl                  | URL for accessing HUAWEI Push Kit, please refer to Sending Messages.                                          |
+
+| Request Parameter | Description                                                         |
+| ----------------- | ------------------------------------------------------------------- |
+| TargetTopic       | Name of a topic to be subscribed to, unsubscribed from, or queried. |
+| TargetCondition   | Combination of condition expressions for a message.                 |
+| TargetToken       | Token of a destination device.                                      |
+| TargetTokenArray  | Tokens of destination devices.                                      |