Skip to content

Commit

Permalink
prepare release 6.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
James Lees committed Apr 27, 2020
1 parent 139bcc3 commit 9c48f4b
Show file tree
Hide file tree
Showing 29 changed files with 19,409 additions and 9,296 deletions.
20 changes: 20 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,25 @@
# Changelog

## 6.0.0 (2020-04-27)

[CHANGED] The default builds for web and worker no longer support encrypted
channels. To use encrypted channels in web/worker you must import
`pusher-js/with-encryption` or use the
`pusher-with-encryption.js`/`pusher-with-encryption.min.js` bundles

[CHANGED] `forceTLS` now defaults to `true`

[REMOVED] the `encrypted` option - this was deprecated in `4.3.0`. The library
defaults to TLS anyway. Setting `encrypted` to `false` will **NOT** change
behaviour

[FIXED] `activityTimeout` and `pongTimeout` options now work as described in
the docs.

[NEW] Typescript declarations for react-native

[NEW] Support for encrypted-channels in react-native and workers

## 5.1.1 (2020-02-12)

[FIXED] An issue with typescript declarations which caused builds to fail on
Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,13 +101,13 @@ const Pusher = require('pusher-js/with-encryption');
#### CDN

```html
<script src="https://js.pusher.com/5.1/pusher.min.js"></script>
<script src="https://js.pusher.com/6.0/pusher.min.js"></script>
```

If you'd like to use encrypted channels:

```html
<script src="https://js.pusher.com/5.1/pusher-with-encryption.min.js"></script>
<script src="https://js.pusher.com/6.0/pusher-with-encryption.min.js"></script>
```

You can also use [cdnjs.com](https://cdnjs.com/libraries/pusher) if you prefer
Expand Down Expand Up @@ -172,13 +172,13 @@ Notes:
You can import the worker script (`pusher.worker.js`, not `pusher.js`) from the CDN:

```javascript
importScripts('https://js.pusher.com/5.1/pusher.worker.min.js');
importScripts('https://js.pusher.com/6.0/pusher.worker.min.js');
```

If you'd like to use encrypted channels:

```javascript
importScripts('https://js.pusher.com/5.1/pusher-with-encryption.worker.min.js');
importScripts('https://js.pusher.com/6.0/pusher-with-encryption.worker.min.js');
```

### Node.js
Expand Down Expand Up @@ -600,17 +600,17 @@ First, clone this repository and run `npm install && git submodule init && git s

In the `dist/web` folder, you should see the files you need: `pusher.js`, `pusher.min.js`, `json2.js`, `json.min.js`, `sockjs.js` and `sockjs.min.js`. `pusher.js` should be built referencing your URLs as the dependency hosts.

First, make sure you expose all files from the `dist` directory. They need to be in a directory with named after the version number. For example, if you're hosting version 5.1.0 under `http://example.com/pusher-js` (and https for SSL), files should be accessible under following URL's:
First, make sure you expose all files from the `dist` directory. They need to be in a directory with named after the version number. For example, if you're hosting version 6.0.0 under `http://example.com/pusher-js` (and https for SSL), files should be accessible under following URL's:

http://example.com/pusher-js/5.1.0/pusher.js
http://example.com/pusher-js/5.1.0/json2.js
http://example.com/pusher-js/5.1.0/sockjs.js
http://example.com/pusher-js/6.0.0/pusher.js
http://example.com/pusher-js/6.0.0/json2.js
http://example.com/pusher-js/6.0.0/sockjs.js

Minified files should have `.min` in their names, as in the `dist/web` directory:

http://example.com/pusher-js/5.1.0/pusher.min.js
http://example.com/pusher-js/5.1.0/json2.min.js
http://example.com/pusher-js/5.1.0/sockjs.min.js
http://example.com/pusher-js/6.0.0/pusher.min.js
http://example.com/pusher-js/6.0.0/json2.min.js
http://example.com/pusher-js/6.0.0/sockjs.min.js

## SockJS compatibility

Expand Down
Loading

0 comments on commit 9c48f4b

Please sign in to comment.