Skip to content

Conversation

@annzenkina
Copy link
Contributor

No description provided.

Copy link
Contributor

@WillSewell WillSewell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally looks good, and I think the channel_client variable makes things clearer (we should do this elsewhere really).

Like with pusher-http-ruby, I suggest also updating the description in package.json.

In addition to that, I think the following should be updated:

  • "In order to use this library, you need to have an account on http://pusher.com" -> "In order to use this library, you need to have an account on https://pusher.com/channels"
  • "Asynchronous methods on the Pusher Channels class" -> "Asynchronous methods on the Pusher class"
  • "To authorise your users to access private channels on Pusher" -> "To authorise your users to access private channels on Pusher Channels"
  • "x-pusher-key - application key, sent by Pusher" -> "x-pusher-key - application key, sent by Channels"
  • "x-pusher-signature - WebHook signature, generated by Pusher" -> "x-pusher-signature - WebHook signature, generated by Channels"
  • "content-type - must be set to application/json, what Pusher does" -> "content-type - must be set to application/json, what Channels does"
  • "Returns the Date object for the time when the WebHook was sent from Pusher" -> "Returns the Date object for the time when the WebHook was sent from Channels"

@annzenkina
Copy link
Contributor Author

@WillSewell done. Not entirely sure, but I think we might need to update the docs here as well: https://www.npmjs.com/package/pusher. What do you think?

@WillSewell
Copy link
Contributor

I think we might need to update the docs here as well: https://www.npmjs.com/package/pusher

I think these will be picked up automatically from the master of Github.

package.json Outdated
"description": "Node.js client to interact with the Pusher REST API",
"version": "2.2.0",
"description": "Node.js client to interact with the Pusher Channels REST API",
"version": "2.2.1",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure you actually need to make a release for these changes to be picked up on https://www.npmjs.com/.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hm. I'll try to merge the PR without changing the version and see how it goes.

@annzenkina annzenkina merged commit 5a71b2c into master Jul 3, 2019
@annzenkina annzenkina deleted the add-channels-readme branch July 3, 2019 10:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants