From b5cbbb83e30d2cb2338699118e0f499fbcc0b1fe Mon Sep 17 00:00:00 2001
From: Korna <17145209+Korna@users.noreply.github.com>
Date: Mon, 7 Nov 2022 20:26:38 +0300
Subject: [PATCH] Add readme for PMP-HPK

---
 README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/README.md b/README.md
index 8d97463..c58e1d8 100644
--- a/README.md
+++ b/README.md
@@ -271,3 +271,32 @@ C) Данные из файла консоли Firebase, добавляемые
         authProviderX509CertUrl: testAuthProviderX509CertUrl
         clientX509CertUrl: testClientX509CertUrl
 ```
+
+## push-message-provider-hpk
+
+Модуль по обеспечению интеграции с Huawei Push Kit. 
+
+1) Подключение компонентов Spring осуществляется при помощи аннотации `@EnablePushMessageProviderHpk`.
+2) Необходимо добавление конфигурации для модуля. Пример файла конфигурации в формате yaml:
+``` yaml
+push-message-provider:
+  platformProviders:
+    ANDROID_HUAWEI:
+      - HPK
+  hpk:
+    web-services:
+      client-id: testClientId
+      oauth:
+        client-secret: testClientSecret
+        url: https://oauth-login.cloud.huawei.com/oauth2/v3/
+        http:
+          connection-timeout: 1s
+          read-timeout: 10s
+          write-timeout: 10s
+      hpk:
+        url: https://push-api.cloud.huawei.com/v1/
+        http:
+          connection-timeout: 1s
+          read-timeout: 10s
+          write-timeout: 10s
+```