Skip to content

Commit 06945f4

Browse files
author
Anya Zenkina
committed
fix according to comments
1 parent 748919d commit 06945f4

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ or install via gem
1818
gem install pusher
1919
```
2020

21-
After registering at <https://dashboard.pusher.com/>, configure your Pusher Channels app with the security credentials.
21+
After registering at <https://dashboard.pusher.com/>, configure your Channels app with the security credentials.
2222

2323
### Instantiating a Pusher Channels client
2424

@@ -62,7 +62,7 @@ channels_client = Pusher::Client.from_env
6262

6363
### Global configuration
6464

65-
Configuring Pusher can also be done globally on the Pusher class.
65+
The library can also be configured globally on the `Pusher` class.
6666

6767
``` ruby
6868
Pusher.app_id = 'your-app-id'
@@ -92,9 +92,9 @@ As of version 0.12, SSL certificates are verified when using the synchronous htt
9292
Pusher.default_client.sync_http_client.ssl_config.verify_mode = OpenSSL::SSL::VERIFY_NONE
9393
```
9494

95-
## Interacting with the Pusher Channels service
95+
## Interacting with the Channels HTTP API
9696

97-
The Pusher gem contains a number of helpers for interacting with the service. As a general rule, the library adheres to a set of conventions that we have aimed to make universal.
97+
The `pusher` gem contains a number of helpers for interacting with the API. As a general rule, the library adheres to a set of conventions that we have aimed to make universal.
9898

9999
### Handling errors
100100

@@ -155,21 +155,21 @@ This will continue to work, but has been replaced by `channels_client.trigger` w
155155

156156
### Getting information about the channels in your Pusher Channels app
157157

158-
This gem provides methods for accessing information from the [Pusher Channels HTTP API](https://pusher.com/docs/rest_api). The documentation also shows an example of the responses from each of the API endpoints.
158+
This gem provides methods for accessing information from the [Channels HTTP API](https://pusher.com/docs/rest_api). The documentation also shows an example of the responses from each of the API endpoints.
159159

160160
The following methods are provided by the gem.
161161

162162
- `channels_client.channel_info('channel_name')` returns information about that channel.
163163

164164
- `channels_client.channel_users('channel_name')` returns a list of all the users subscribed to the channel.
165165

166-
- `channels_client.channels` returns information about all the channels in your Pusher Channels application.
166+
- `channels_client.channels` returns information about all the channels in your Channels application.
167167

168168
### Asynchronous requests
169169

170170
There are two main reasons for using the `_async` methods:
171171

172-
* In a web application where the response from the Pusher Channels HTTP API is not used, but you'd like to avoid a blocking call in the request-response cycle
172+
* In a web application where the response from the Channels HTTP API is not used, but you'd like to avoid a blocking call in the request-response cycle
173173
* Your application is running in an event loop and you need to avoid blocking the reactor
174174

175175
Asynchronous calls are supported either by using an event loop (eventmachine, preferred), or via a thread.
@@ -180,7 +180,7 @@ The following methods are available (in each case the calling interface matches
180180
* `channels_client.post_async`
181181
* `channels_client.trigger_async`
182182

183-
It is of course also possible to make calls to the Pusher Channels HTTP API via a job queue. This approach is recommended if you're sending a large number of events.
183+
It is of course also possible to make calls to the Channels HTTP API via a job queue. This approach is recommended if you're sending a large number of events.
184184

185185
#### With EventMachine
186186

@@ -197,7 +197,7 @@ channels_client.get_async("/channels").callback { |response|
197197
}
198198
```
199199

200-
A HTTP error or an error response from pusher will cause the errback to be called with an appropriate error object.
200+
A HTTP error or an error response from Channels will cause the errback to be called with an appropriate error object.
201201

202202
#### Without EventMachine
203203

@@ -208,7 +208,7 @@ An `HTTPClient::Connection` object is returned immediately which can be [interro
208208

209209
## Authenticating subscription requests
210210

211-
It's possible to use the gem to authenticate subscription requests to private or presence channels. The `authenticate` method is available on a channel object for this purpose and returns a JSON object that can be returned to the client that made the request. More information on this authentication scheme can be found in the docs on <http://pusher.com>
211+
It's possible to use the gem to authenticate subscription requests to private or presence channels. The `authenticate` method is available on a channel object for this purpose and returns a JSON object that can be returned to the client that made the request. More information on this authentication scheme can be found in the docs on <https://pusher.com/docs/channels/server_api/authenticating-users>
212212

213213
### Private channels
214214

0 commit comments

Comments
 (0)