Skip to content

Commit b1e717c

Browse files
sfcgeorgeAnya Zenkina
authored andcommitted
Update README.md (#149)
* Add version badge to README.md It can be useful to compare `version.rb` with the version on Rubygems to see if the gem is up to date. Having a badge on the README saves a step. * Fixes doc links (they were all 404s). * Use more helpful signup link
1 parent 6782dd3 commit b1e717c

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Gem for Pusher Channels
22

3-
This Gem provides a Ruby interface to [the Pusher HTTP API for Pusher Channels](https://pusher.com/docs/rest_api).
3+
This Gem provides a Ruby interface to [the Pusher HTTP API for Pusher Channels](https://pusher.com/docs/channels/library_auth_reference/rest-api).
44

5-
[![Build Status](https://secure.travis-ci.org/pusher/pusher-http-ruby.svg?branch=master)](http://travis-ci.org/pusher/pusher-http-ruby)
5+
[![Build Status](https://secure.travis-ci.org/pusher/pusher-http-ruby.svg?branch=master)](http://travis-ci.org/pusher/pusher-http-ruby) [![Gem Version](https://badge.fury.io/rb/pusher.svg)](https://badge.fury.io/rb/pusher)
66

77
## Installation and Configuration
88

@@ -18,7 +18,7 @@ or install via gem
1818
gem install pusher
1919
```
2020

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

2323
### Instantiating a Pusher Channels client
2424

@@ -125,7 +125,7 @@ channels_client.trigger('channel', 'event', foo: 'bar')
125125
channels_client.trigger(['channel_1', 'channel_2'], 'event_name', foo: 'bar')
126126
```
127127

128-
An optional fourth argument may be used to send additional parameters to the API, for example to [exclude a single connection from receiving the event](http://pusher.com/docs/publisher_api_guide/publisher_excluding_recipients).
128+
An optional fourth argument may be used to send additional parameters to the API, for example to [exclude a single connection from receiving the event](https://pusher.com/docs/channels/server_api/excluding-event-recipients).
129129

130130
``` ruby
131131
channels_client.trigger('channel', 'event', {foo: 'bar'}, {socket_id: '123.456'})
@@ -155,7 +155,7 @@ 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 [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/channels/library_auth_reference/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

0 commit comments

Comments
 (0)