Skip to content

Commit

Permalink
Document client usage.
Browse files Browse the repository at this point in the history
Fixes #37.
  • Loading branch information
tristandunn committed Dec 14, 2014
1 parent 2fbf594 commit 3fe8226
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,18 @@ web: PUSHER_FAKE=1 bundle exec unicorn ...
worker: bundle exec ...
```

### Clients

If you're creating a `Pusher::Client` instance and wish to use the fake, you need to provide the options.

```ruby
Pusher::Client.new({
key: Pusher.key,
app_id: Pusher.app_id,
secret: Pusher.secret
}.merge(PusherFake.configuration.web_options))
```

## Configuration

Note that the application ID, API key, and token are automatically set to the `Pusher` values when using an included support file.
Expand Down

0 comments on commit 3fe8226

Please sign in to comment.