From 658409dc2e3e3357737adb738930f7fde5e1c493 Mon Sep 17 00:00:00 2001
From: Artyom <17145209+Korna@users.noreply.github.com>
Date: Mon, 22 Aug 2022 15:11:01 +0300
Subject: [PATCH] Update readme file

---
 README.md                                     | 40 +++++++++++++++++--
 .../resources/credentials/firebase-admin.json | 12 ------
 2 files changed, 36 insertions(+), 16 deletions(-)
 delete mode 100644 push-message-provider-fcm/src/test/resources/credentials/firebase-admin.json

diff --git a/README.md b/README.md
index ff07fe9..b0adad7 100644
--- a/README.md
+++ b/README.md
@@ -222,7 +222,7 @@ server.info:
 
 Модуль по обеспечению интеграции с Firebase Cloud Messaging. 
 1) Подключение компонентов Spring осуществляется при помощи аннотации `@EnablePushMessageProviderFcm`.
-2) Необходимо добавление конфигурации для модуля. Пример файла конфигурации в формате yaml:
+2) Необходимо добавление конфигурации для модуля с выбранным способом хранения данных для авторизации. Пример файла конфигурации в формате yaml:
 ``` yaml
 push-message-provider:
   platformProviders:
@@ -231,11 +231,43 @@ push-message-provider:
     IOS:
       - FCM
   fcm:
-    appName: ${appName}
+    appName: # Название приложения
     auth:
-      resourcePath: credentials/firebase-admin.json
+      # Выбранный тип авторизации
     client:
       readTimeout: 10s
       connectionTimeout: 1s
 ```
-3) По обозначенному пути `push-message-provider-fcm.auth.resourcePath` добавляется json файл с настройками и доступами из консоли Firebase.
+3) Настраивается способ предоставления авторизации для Firebase Cloud Messaging.
+
+А) Токен доступа из консоли Google, добавляемый в конфигурацию настроек:
+``` yaml
+    auth:
+      token:
+        value: testValue
+        expiresAt: 2023-01-01T23:59:59 +00:00
+```
+B) Данные в файле из консоли Firebase, добавляемые в resources с обозначением пути в конфигурации настроек:
+``` yaml
+    auth:
+      credentialsFile:
+        path: credentials/firebase-admin.json
+```
+C) Данные из файла консоли Firebase, добавляемые в конфигурацию настроек:
+``` yaml
+    auth:
+      credentialsData:
+        type: service_account
+        projectId: testProjectId
+        privateKeyId: testPrivateKeyId
+        privateKey: |
+          -----BEGIN PRIVATE KEY-----
+          MIICdwIBADANBgkqhkiG9w0BAQEFAASCAmEwggJdAgEAAoGBALfBshaLMW2yddmAZJRNXTZzcSbwvY93Dnjj6naWgoBJoB3mOM5bcoyWwBw12A4rwecorz74OUOc6zdqX3j8hwsSyzgAUStKM5PkOvPNRKsI4eXAWU0fmb8h1jyXwftl7EzeBjEMBTpyXkgDk3wLfHN6ciCZrnQndOvS+mMl3b0hAgMBAAECgYEAmIQZByMSrITR0ewCDyFDO52HjhWEkF310hsBkNoNiOMTFZ3vCj/WjJ/W5dM+90wUTYN0KOSnytmkVUNh6K5Yekn+yRg/mBRTwwn88hU6umB8tUqoNz7AyUltAOGyQMWqAAcVgxV+mAp/Y018j69poEHgrW4qKol65/NRZyV7/J0CQQD4rCDjmxGEuA1yMzL2i8NyNl/5vvLVfLcEnVqpHbc1+KfUHZuY7iv38xpzfmErqhCxAXfQ52edq5rXmMIVSbFrAkEAvSvfSSK9XQDJl3NEyfR3BGbsoqKIYOuJAnv4OQPSODZfTNWhc11S8y914qaSWB+Iid9HoLvAIgPH5mrzPzjSowJBAJcw4FZCI+aTmOlEI8ous8gvMy8/X5lZWFUf7s0/2fKgmjmnPsE+ndEFJ6HsxturbLaR8+05pJAClARdRjN3OL0CQGoF+8gmw1ErztCmVyiFbms2MGxagesoN4r/5jg2Tw0YVENg/HMHHCWWNREJ4L2pNsJnNOL+N4oY6mHXEWwesdcCQCUYTfLYxi+Wg/5BSC7fgl/gu0mlx07AzMoMQLDOXdisV5rpxrOoT3BOLBqyccv37AZ3e2gqb8JYyNzO6C0zswQ=
+          -----END PRIVATE KEY-----
+        clientEmail: testClientEmail
+        clientId: testClientId
+        authUri: testAuthUri
+        tokenUri: testTokenUri
+        authProviderX509CertUrl: testAuthProviderX509CertUrl
+        clientX509CertUrl: testClientX509CertUrl
+```
diff --git a/push-message-provider-fcm/src/test/resources/credentials/firebase-admin.json b/push-message-provider-fcm/src/test/resources/credentials/firebase-admin.json
deleted file mode 100644
index 2eaa59f..0000000
--- a/push-message-provider-fcm/src/test/resources/credentials/firebase-admin.json
+++ /dev/null
@@ -1,12 +0,0 @@
-{
-  "type": "service_account",
-  "project_id": "testProjectId",
-  "private_key_id": "privateKeyId",
-  "private_key": "-----BEGIN PRIVATE KEY-----\nMIICdwIBADANBgkqhkiG9w0BAQEFAASCAmEwggJdAgEAAoGBALfBshaLMW2yddmAZJRNXTZzcSbwvY93Dnjj6naWgoBJoB3mOM5bcoyWwBw12A4rwecorz74OUOc6zdqX3j8hwsSyzgAUStKM5PkOvPNRKsI4eXAWU0fmb8h1jyXwftl7EzeBjEMBTpyXkgDk3wLfHN6ciCZrnQndOvS+mMl3b0hAgMBAAECgYEAmIQZByMSrITR0ewCDyFDO52HjhWEkF310hsBkNoNiOMTFZ3vCj/WjJ/W5dM+90wUTYN0KOSnytmkVUNh6K5Yekn+yRg/mBRTwwn88hU6umB8tUqoNz7AyUltAOGyQMWqAAcVgxV+mAp/Y018j69poEHgrW4qKol65/NRZyV7/J0CQQD4rCDjmxGEuA1yMzL2i8NyNl/5vvLVfLcEnVqpHbc1+KfUHZuY7iv38xpzfmErqhCxAXfQ52edq5rXmMIVSbFrAkEAvSvfSSK9XQDJl3NEyfR3BGbsoqKIYOuJAnv4OQPSODZfTNWhc11S8y914qaSWB+Iid9HoLvAIgPH5mrzPzjSowJBAJcw4FZCI+aTmOlEI8ous8gvMy8/X5lZWFUf7s0/2fKgmjmnPsE+ndEFJ6HsxturbLaR8+05pJAClARdRjN3OL0CQGoF+8gmw1ErztCmVyiFbms2MGxagesoN4r/5jg2Tw0YVENg/HMHHCWWNREJ4L2pNsJnNOL+N4oY6mHXEWwesdcCQCUYTfLYxi+Wg/5BSC7fgl/gu0mlx07AzMoMQLDOXdisV5rpxrOoT3BOLBqyccv37AZ3e2gqb8JYyNzO6C0zswQ=\n-----END PRIVATE KEY-----\n",
-  "client_email": "clientEmail",
-  "client_id": "clientId",
-  "auth_uri": "https://accounts.google.com/o/oauth2/auth",
-  "token_uri": "https://accounts.google.com/o/oauth2/token",
-  "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
-  "client_x509_cert_url": "clientX509CertUrl"
-}