Skip to content

Commit

Permalink
Preparing for release, 0.13.0.
Browse files Browse the repository at this point in the history
  • Loading branch information
dblock committed Sep 8, 2018
1 parent fc9b5b1 commit a4d6fb0
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -18,7 +18,7 @@ A Ruby client for the Slack [Web](https://api.slack.com/web) and [RealTime Messa

## Stable Release

You're reading the documentation for the **next** release of slack-ruby-client. Please see the documentation for the [last stable release, v0.12.0](https://github.com/slack-ruby/slack-ruby-client/blob/v0.12.0/README.md) unless you're integrating with HEAD. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
You're reading the documentation for the **stable** release of slack-ruby-client, v0.13.0. See [UPGRADING](UPGRADING.md) when upgrading from an older version.

## Installation

Expand Down
12 changes: 7 additions & 5 deletions UPGRADING.md
@@ -1,19 +1,21 @@
Upgrading Slack-Ruby-Client
===========================

### Upgrading to >= 0.12.2
### Upgrading to >= 0.13.0

#### Recommended Async Library

The RealTime client now supports [async-websocket](https://github.com/socketry/async-websocket), which is now the recommended library following numerous disconnect issues in [#208](https://github.com/slack-ruby/slack-ruby-client/issues/208).
The RealTime client now supports [async-websocket](https://github.com/socketry/async-websocket), which is actively maintained and is now the recommended library.

See [#219](https://github.com/slack-ruby/slack-ruby-client/pull/219) for details.
See [#219](https://github.com/slack-ruby/slack-ruby-client/pull/219) for implementation details.

#### Async Library Threading and Reactor Changes

The RealTime celluloid-io implementation now uses a `Thread` per client. Previous versions used an `Actor`.

The faye-websocket implementation with EventMachine will attempt to shutdown EventMachine via `EventMachine.stop` upon shutdown if a reactor wasn't already running. See [#224](https://github.com/slack-ruby/slack-ruby-client/pull/224) for details.
The faye-websocket implementation with EventMachine will attempt to shutdown EventMachine via `EventMachine.stop` upon shutdown if a reactor wasn't already running.

See [#224](https://github.com/slack-ruby/slack-ruby-client/pull/224) for more information.

### Upgrading to >= 0.9.0

Expand Down Expand Up @@ -51,7 +53,7 @@ Slack::RealTime::Client.config do |config|
end
```

See [#136](https://github.com/slack-ruby/slack-ruby-client/pull/136) for more details.
See [#136](https://github.com/slack-ruby/slack-ruby-client/pull/136) for more information.

### Upgrading to >= 0.6.0

Expand Down

0 comments on commit a4d6fb0

Please sign in to comment.