Skip to content

Commit ba32489

Browse files
authored
Rename Pusher -> Pusher Channels in README (#144)
1 parent d153e38 commit ba32489

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ $ sudo apt-get install build-essential libssl-dev libffi-dev
5151

5252
## Getting started
5353

54-
The minimum configuration required to use the Pusher object are the three
55-
constructor arguments which identify your Pusher app. You can find them by
54+
The minimum configuration required to use the `Pusher` object are the three
55+
constructor arguments which identify your Pusher Channels app. You can find them by
5656
going to "API Keys" on your app at <https://app.pusher.com>.
5757

5858
```python
@@ -76,9 +76,9 @@ pusher_client = pusher.Pusher(app_id, key, secret, cluster=u'cluster')
7676

7777
|Argument |Description |
7878
|:-:|:-:|
79-
|app_id `String` |**Required** <br> The Pusher application ID |
80-
|key `String` |**Required** <br> The Pusher application key |
81-
|secret `String` |**Required** <br> The Pusher application secret token |
79+
|app_id `String` |**Required** <br> The Pusher Channels application ID |
80+
|key `String` |**Required** <br> The Pusher Channels application key |
81+
|secret `String` |**Required** <br> The Pusher Channels application secret token |
8282
|cluster `String` | **Default:`mt1`** <br> The pusher application cluster. Will be overwritten if `host` is set |
8383
|host `String` | **Default:`None`** <br> The host to connect to |
8484
|port `int` | **Default:`None`** <br>Which port to connect to |
@@ -357,7 +357,7 @@ Users can configure the library to use different backends to send calls to our A
357357
* [AsyncIO](http://asyncio.org/) (`pusher.aiohttp.AsyncIOBackend`).
358358
* [Google App Engine](https://cloud.google.com/appengine/docs/python/urlfetch/) (`pusher.gae.GAEBackend`).
359359

360-
Upon initializing a Pusher instance, pass in any of these options to the `backend` keyword argument.
360+
Upon initializing a `Pusher` instance, pass in any of these options to the `backend` keyword argument.
361361

362362
### Google App Engine
363363

@@ -387,7 +387,7 @@ HTTP KeepAlive | *&#10008;*
387387

388388
#### Helper Functionality
389389

390-
These are helpers that have been implemented to to ensure interactions with the HTTP API only occur if they will not be rejected e.g. [channel naming conventions](https://pusher.com/docs/client_api_guide/client_channels#naming-channels).
390+
These are helpers that have been implemented to to ensure interactions with the HTTP API only occur if they will not be rejected e.g. [channel naming conventions](https://pusher.com/docs/channels/using_channels/channels#channel-naming-conventions).
391391

392392
Helper Functionality | Supported
393393
-----------------------------------------| :-------:

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
setup(
1515
name='pusher',
1616
version=VERSION,
17-
description='A Python library to interract with the Pusher API',
17+
description='A Python library to interract with the Pusher Channels API',
1818
url='https://github.com/pusher/pusher-http-python',
1919
author='Pusher',
2020
author_email='support@pusher.com',

0 commit comments

Comments
 (0)