update README.md

denis660 · Dec 5, 2021 · b8a29a1 · b8a29a1
1 parent 64c37f9
commit b8a29a1
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 22 deletions.
diff --git a/README.md b/README.md
@@ -13,7 +13,8 @@
 </p>
 
 ## Introduction
-Centrifugo broadcaster for laravel is fork of [Laracent](https://github.com/AlexHnydiuk/Laracent), based on:
+Centrifugo broadcaster for laravel , based on:
+- [LaraComponents/centrifugo-broadcaster](https://github.com/LaraComponents/centrifugo-broadcaster)
 - [centrifugal/phpcent](https://github.com/centrifugal/phpcent)
 
 ## Features
@@ -23,7 +24,7 @@ Centrifugo broadcaster for laravel is fork of [Laracent](https://github.com/Ale
 
 ## Requirements
 - PHP >= 7.3 , 8.0, 8.1
-- Laravel 7.30.4 - 8.1
+- Laravel 7.30.4 - 8.6.8
 - guzzlehttp/guzzle 6 - 7
 - Centrifugo Server 3.1.0 or newer (see [here](https://github.com/centrifugal/centrifugo))
 
@@ -80,7 +81,7 @@ BROADCAST_DRIVER=centrifugo
 
 ## Basic Usage
 
-To configure Centrifugo server, read [official documentation](https://centrifugal.github.io/centrifugo/)
+To configure Centrifugo server, read [official documentation](https://centrifugal.dev)
 
 For broadcasting events, see [official documentation of laravel](https://laravel.com/docs/8.x/broadcasting)
 

diff --git a/README_RU.md b/README_RU.md
@@ -13,20 +13,20 @@
 </p>
 
 ## Введение
-Centrifugo broadcaster для laravel  это форк репозитория [Laracent](https://github.com/AlexHnydiuk/Laracent), based on:
+Centrifugo broadcaster для laravel , основан на :
 - [LaraComponents/centrifugo-broadcaster](https://github.com/LaraComponents/centrifugo-broadcaster)
 - [centrifugal/phpcent](https://github.com/centrifugal/phpcent)
 
 ## Особенности
-- Совместимость с последней версией [Centrifugo 2.8.5](https://github.com/centrifugal/centrifugo/releases/tag/v2.8.5) 🚀
-- Обертка над [Centrifugo HTTP API](https://centrifugal.github.io/centrifugo/server/http_api/) 🔌
-- Аутентификация с помощью токена JWT (HMAC алгоритм) для [анонимного](./Resources/docs/authentication.md#anonymous), [авторизованного пользователя](./Resources/docs/authentication.md#authenticated-user) и [приватного канала](./Resources/docs/authentication.md#private-channel) 🗝️
+- Совместимость с последней версией [Centrifugo 3.1.0](https://github.com/centrifugal/centrifugo/releases/tag/v3.1.0) 🚀
+- Обертка над [Centrifugo HTTP API](https://centrifugal.dev/docs/server/server_api) 🔌
+- Аутентификация с помощью токена JWT (HMAC алгоритм) для анонимного, авторизованного пользователя и приватного канала 🗝️
 
 ## Требования
-- PHP >= 7.3
-- Framework Laravel 7.30.4 - 8
+- PHP >= 7.3, 8.0, 8.1
+- Framework Laravel 7.30.4 - 8.6.8
 - guzzlehttp/guzzle 6 - 7
-- Centrifugo Сервер 2.8.6 или новее (см. [здесь](https://github.com/centrifugal/centrifugo))
+- Centrifugo Сервер 3.1.0 или новее (см. [здесь](https://github.com/centrifugal/centrifugo))
 
 ## Установка
 Установить через composer, выполнив команду в консоле:
@@ -49,8 +49,8 @@ composer req denis660/laravel-centrifugo
 ```php
  'centrifugo' => [
  'driver' => 'centrifugo',
- 'secret' => env('CENTRIFUGO_SECRET'),
- 'apikey' => env('CENTRIFUGO_APIKEY'),
+ 'token_hmac_secret_key' => env('CENTRIFUGO_TOKEN_HMAC_SECRET_KEY',''),
+ 'api_key' => env('CENTRIFUGO_API_KEY',''),
  'url' => env('CENTRIFUGO_URL', 'http://localhost:8000'), // centrifugo api url
  'verify' => env('CENTRIFUGO_VERIFY', false), // Verify host ssl if centrifugo uses this
  'ssl_key' => env('CENTRIFUGO_SSL_KEY', null), // Self-Signed SSl Key for Host (require verify=true)
@@ -59,8 +59,8 @@ composer req denis660/laravel-centrifugo
 
 Также вы должны добавить эти две строчки в ваш .env файл:
 ```
-CENTRIFUGO_SECRET=token_hmac_secret_key-from-centrifugo-config
-CENTRIFUGO_APIKEY=api_key-from-centrifugo-config
+CENTRIFUGO_TOKEN_HMAC_SECRET_KEY=token_hmac_secret_key-from-centrifugo-config
+CENTRIFUGO_API_KEY=api_key-from-centrifugo-config
 ```
 
 Эти строки необязательны:
@@ -78,7 +78,7 @@ BROADCAST_DRIVER=centrifugo
 
 ## Базовое использование
 
-Настройте ваш сервер Centrifugo , детальнее в [официальной документации](https://centrifugal.github.io/centrifugo/)
+Настройте ваш сервер Centrifugo , детальнее в [официальной документации](https://centrifugal.dev)
 
 Для отправки событий, почитайте [официальную документацию для Laravel](https://laravel.com/docs/8.x/broadcasting)
 
@@ -126,18 +126,19 @@ class ExampleController
 
 | Название | Описание |
 |------|-------------|
-| publish(string $channel, array $data) | Отправка сообщения в канал |
-| broadcast(array $channels, array $data) | Отправить сообщение в несколько каналов. |
+| publish(string $channel, array $data, $skipHistory = false) | Отправка сообщения в канал |
+| broadcast(array $channels, array $data, $skipHistory = false) | Отправить сообщение в несколько каналов. |
 | presence(string $channel) | Получите информацию о присутствии в канале (все клиенты в настоящее время подписаны на этот канал). |
 | presenceStats(string $channel) | Получите краткую информацию о канале (количество клиентов).|
-| history(string $channel) | Получить информацию об истории канала (список последних сообщений, отправленных в канал). |
+| history(string $channel, $limit = 0, $since = [], $reverse = false) | Получить информацию об истории канала (список последних сообщений, отправленных в канал). |
 | historyRemove(string $channel) | Удалить информацию из истории канала. |
-| unsubscribe(string $channel, string $user) | Отписать пользователя от канала. |
+| subscribe(string $channel, string $user, $client = '') | Подписать пользователя на канал |
+| unsubscribe(string $channel, string $user, string $client = '') | Отписать пользователя от канала. |
 | disconnect(string $user_id) | Отключить пользователя по его ID. |
-| channels() | Cписок текущих активных каналов. |
+| channels(string $pattern = '') | Cписок текущих активных каналов. |
 | info() | Статистическая информация о запущенных серверных узлах. |
-| generateConnectionToken(string $userId, int $exp, array $info) | Генерация токена для подключения |
-| generatePrivateChannelToken(string $client, string $channel, int $exp, array $info) | Генерация приватного токена для приватного канала |
+| generateConnectionToken(string $userId = '', int $exp = 0, array $info = [], array $channels = []) | Генерация токена для подключения |
+| generatePrivateChannelToken(string $client, string $channel, int $exp = 0, array $info = []) | Генерация приватного токена для приватного канала |
 
 ## Лицения