Skip to content

Commit 0d83c57

Browse files
author
Callum Oakley
committed
added Push Notifications section to TOC and updated heading style in readme
1 parent 2fcf070 commit 0d83c57

File tree

1 file changed

+12
-21
lines changed

1 file changed

+12
-21
lines changed

README.md

Lines changed: 12 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,20 @@ This package lets you trigger events to your client and query the state of your
88

99
In order to use this library, you need to have a free account on <http://pusher.com>. After registering, you will need the application credentials for your app.
1010

11-
Features
12-
--------
11+
## Features
1312

1413
* Python 2.6, 2.7 and 3.3 support
1514
* Adapters for various http libraries like requests, urlfetch, aiohttp and tornado.
1615
* WebHook validation
1716
* Signature generation for socket subscriptions
1817

19-
###Table of Contents
18+
### Table of Contents
2019

2120
- [Installation](#installation)
2221
- [Getting started](#getting-started)
2322
- [Configuration](#configuration)
2423
- [Triggering Events](#triggering-events)
24+
- [Push Notifications (BETA)](#push-notifications-beta)
2525
- [Querying Application State](#querying-application-state)
2626
- [Getting Information For All Channels](#getting-information-for-all-channels)
2727
- [Getting Information For A Specific Channel](#getting-information-for-a-specific-channel)
@@ -34,8 +34,7 @@ Features
3434
- [Running the tests](#running-the-tests)
3535
- [License](#license)
3636

37-
Installation
38-
------------
37+
## Installation
3938

4039
You can install this module using your package management method or choice,
4140
normally `easy_install` or `pip`. For example:
@@ -46,8 +45,7 @@ pip install pusher
4645

4746
Users on Python 2.x and older versions of pip may get a warning, due to pip compiling the optional `pusher.aiohttp` module, which uses Python 3 syntax. However, as `pusher.aiohttp` is not used by default, this does not affect the library's functionality. See [our Github issue](https://github.com/pusher/pusher-http-python/issues/52), as well as [this issue from Gunicorn](https://github.com/benoitc/gunicorn/issues/788) for more details.
4847

49-
Getting started
50-
---------------
48+
## Getting started
5149

5250
The minimum configuration required to use the Pusher object are the three
5351
constructor arguments which identify your Pusher app. You can find them by
@@ -92,8 +90,7 @@ from pusher import Pusher
9290
pusher = Pusher(app_id=u'4', key=u'key', secret=u'secret', ssl=True, cluster=u'eu')
9391
```
9492

95-
Triggering Events
96-
-----------------
93+
## Triggering Events
9794

9895
To trigger an event on one or more channels, use the `trigger` method on the `Pusher` object.
9996

@@ -211,8 +208,7 @@ data = {
211208

212209
**NOTE:** This is currently a BETA feature and there might be minor bugs and issues. Changes to the API will be kept to a minimum, but changes are expected. If you come across any bugs or issues, please do get in touch via [support](support@pusher.com) or create an issue here.
213210

214-
Querying Application State
215-
-----------------
211+
## Querying Application State
216212

217213
### Getting Information For All Channels
218214

@@ -275,8 +271,7 @@ pusher.users_info(u'presence-chatroom')
275271
#=> {u'users': [{u'id': u'1035'}, {u'id': u'4821'}]}
276272
```
277273

278-
Authenticating Channel Subscription
279-
-----------------
274+
## Authenticating Channel Subscription
280275

281276
#### `Pusher::authenticate`
282277

@@ -329,8 +324,7 @@ auth = pusher.authenticate(
329324
# return `auth` as a response
330325
```
331326

332-
Receiving Webhooks
333-
-----------------
327+
## Receiving Webhooks
334328

335329
If you have webhooks set up to POST a payload to a specified endpoint, you may wish to validate that these are actually from Pusher. The `Pusher` object achieves this by checking the authentication signature in the request body using your application credentials.
336330

@@ -408,13 +402,11 @@ Limit to 10 channels per trigger | &#10004;
408402
Limit event name length to 200 chars | &#10004;
409403

410404

411-
Running the tests
412-
-----------------
405+
## Running the tests
413406

414407
To run the tests run `python setup.py test`
415408

416-
Making a release
417-
----------------
409+
## Making a release
418410

419411
* Update the CHANGELOG.md file. `git changelog` from the
420412
[git-extras](https://github.com/tj/git-extras/blob/master/Commands.md#git-changelog) package can be useful to pull commits from the release.
@@ -426,7 +418,6 @@ Making a release
426418
If you get the `error: invalid command 'bdist_wheel'` message on the last step
427419
`pip install wheel` and re-run `make`.
428420

429-
License
430-
-------
421+
## License
431422

432423
Copyright (c) 2015 Pusher Ltd. See LICENSE for details.

0 commit comments

Comments
 (0)