Skip to content

Commit 528e97e

Browse files
author
Jon Elverkilde
committed
Fix badges, fix use_tls references in README
1 parent 8b2f5b1 commit 528e97e

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
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://github.com/pusher/pusher-http-ruby/workflows/Tests/badge.svg)](https://github.com/pusher/pusher-http-ruby/actions?query=workflow%3ATests+branch%3Amaster) [![Gem Version](https://badge.fury.io/rb/pusher.svg)](https://badge.fury.io/rb/pusher)
5+
[![Build Status](https://github.com/pusher/pusher-http-ruby/workflows/Tests/badge.svg)](https://github.com/pusher/pusher-http-ruby/actions?query=workflow%3ATests+branch%3Amaster) [![Gem](https://img.shields.io/gem/v/pusher)](https://rubygems.org/gems/pusher) [![Gem](https://img.shields.io/gem/dt/pusher)](https://rubygems.org/gems/pusher)
66

77
## Supported Platforms
88

@@ -40,7 +40,7 @@ pusher = Pusher::Client.new(
4040
)
4141
```
4242

43-
The `cluster` value will set the `host` to `api-<cluster>.pusher.com`. The `use_tls` value is optional and defaults to `false`. It will set the `scheme` and `port`. Custom `scheme` and `port` values take precendence over `use_tls`.
43+
The `cluster` value will set the `host` to `api-<cluster>.pusher.com`. The `use_tls` value is optional and defaults to `true`. It will set the `scheme` and `port`. A custom `port` value takes precendence over `use_tls`.
4444

4545
If you want to set a custom `host` value for your client then you can do so when instantiating a Pusher Channels client like so:
4646

@@ -83,11 +83,11 @@ If you need to make requests via a HTTP proxy then it can be configured
8383
Pusher.http_proxy = 'http://(user):(password)@(host):(port)'
8484
```
8585

86-
By default API requests are made over HTTP. HTTPS can be used by setting `encrypted` to `true`.
86+
By default API requests are made over HTTPS. HTTP can be used by setting `use_tls` to `false`.
8787
Issuing this command is going to reset `port` value if it was previously specified.
8888

8989
``` ruby
90-
Pusher.encrypted = true
90+
Pusher.use_tls = false
9191
```
9292

9393
As of version 0.12, SSL certificates are verified when using the synchronous http client. If you need to disable this behaviour for any reason use:

0 commit comments

Comments
 (0)