Skip to content

Commit 4333826

Browse files
authored
Merge pull request #56 from pusher/pusher-channels-rename
Make it clear this is for the Channels product in the README
2 parents c041b54 + ce73d3a commit 4333826

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

README.md

+9-8
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ If you want you can use the [facade](http://laravel.com/docs/facades). Add the r
4141

4242
## Configuration
4343

44-
Laravel Pusher requires connection configuration. To get started, you'll need to publish all vendor assets:
44+
The Laravel Channels SDK requires connection configuration. To get started, you'll need to publish all vendor assets:
4545

4646
```bash
4747
$ php artisan vendor:publish --provider="Pusher\Laravel\PusherServiceProvider"
@@ -53,18 +53,19 @@ This will create a `config/pusher.php` file in your app that you can modify to s
5353

5454
This option `default` is where you may specify which of the connections below you wish to use as your default connection for all work. Of course, you may use many connections at once using the manager class. The default value for this setting is `main`.
5555

56-
#### Pusher Connections
56+
#### Channels Connections
5757

5858
This option `connections` is where each of the connections are setup for your application. Example configuration has been included, but you may add as many connections as you would like.
5959

6060
#### Encrypted Channels
61-
To enable [end to end encrypted channels](https://pusher.com/docs/client_api_guide/client_encrypted_channels), you need to uncomment a line from the Pusher config file
61+
62+
To enable [end to end encrypted channels](https://pusher.com/docs/client_api_guide/client_encrypted_channels), you need to uncomment a line from the Channels config file
6263

6364
```
64-
'app_id' => env('PUSHER_APP_ID'),
65+
'app_id' => env('APP_ID'),
6566
'options' => [
66-
'cluster' => env('PUSHER_APP_CLUSTER'),
67-
'encryption_master_key' => env('PUSHER_ENCRYPTION_MASTER_KEY'),
67+
'cluster' => env('APP_CLUSTER'),
68+
'encryption_master_key' => env('ENCRYPTION_MASTER_KEY'),
6869
],
6970
'host' => null,
7071
'port' => null,
@@ -102,7 +103,7 @@ Pusher::getSettings();
102103
// This example is simple and there are far more methods available.
103104
```
104105

105-
The Pusher manager will behave like it is a `Pusher`. If you want to call specific connections, you can do that with the connection method:
106+
The `PusherManager` will behave like it is a `Pusher`. If you want to call specific connections, you can do that with the connection method:
106107

107108
```php
108109
use Pusher\Laravel\Facades\Pusher;
@@ -148,7 +149,7 @@ App::make('Foo')->bar();
148149

149150
## Documentation
150151

151-
There are other classes in this package that are not documented here. This is because the package is a Laravel wrapper of [the official Pusher package](https://github.com/pusher/pusher-php-server).
152+
There are other classes in this package that are not documented here. This is because the package is a Laravel wrapper of [the official Channels package](https://github.com/pusher/pusher-php-server).
152153

153154
## License
154155

0 commit comments

Comments
 (0)