[skip ci] Prepare release v0.3.0

esl · May 30, 2017 · 8229a50 · 8229a50
1 parent 9fb17eb
commit 8229a50
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## v0.3.0 - 2017-05-30
+
+### Added
+* encoding and decoding of ChannelData messages
+* encoding and decoding of ChannelBind method and CHANNEL-NUMBER attribute
+* support for TURN channels mechanism for data exchange (`Jerboa.Client.open_channel/2`)
+
+### Fixed
+* multiple bugs around permissions by changing the design of acknowledging permissions - permissions are
+  tracked only after a successful CreatePermission arrives from the server
+
 ## v0.2.0 - 2017-05-16
 
 ### Added

diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@
 [![Coverage Status](https://coveralls.io/repos/github/esl/jerboa/badge.svg?branch=master)](https://coveralls.io/github/esl/jerboa?branch=master)
 [![Ebert](https://ebertapp.io/github/esl/jerboa.svg)](https://ebertapp.io/github/esl/jerboa)
 
-[Documentation](https://hexdocs.pm/jerboa/0.2.0)
+[Documentation](https://hexdocs.pm/jerboa/0.3.0)
 
 
 STUN/TURN encoder, decoder and client library by [Erlang Solutions](https://www.erlang-solutions.com)
@@ -19,7 +19,7 @@ Jerboa is available on [Hex](https://hex.pm/packages/jerboa). To use it, just ad
 
 ```elixir
 def deps do
-  [{:jerboa, "~> 0.2.0"}]
+  [{:jerboa, "~> 0.3.0"}]
 end
 ```
 
@@ -31,7 +31,7 @@ end
 - [x] Send
 - [x] Data
 - [x] CreatePermission
-- [ ] ChannelBind
+- [x] ChannelBind
 
 ### Checklist of STUN/TURN/ICE attributes supported by Jerboa's encoder/decoder
 

diff --git a/lib/jerboa/client.ex b/lib/jerboa/client.ex
@@ -72,6 +72,14 @@ defmodule Jerboa.Client do
   peer which you've not installed permissions for, the data will never appear in subscribed
   process' mailbox.
 
+  ### Channels
+
+  If you're exchanging a lot of data with one of the peers, you might want to use
+  channels mechanism. Data sent throught the channel carries smaller message
+  header, so throughput of user data increases. Note that unlike permissions,
+  channels must be bound to both IP address and specific port number. To learn
+  more see `open_channel/2`.
+
   ## Logging
 
   Client logs progress messages with `:debug` level, so Elixir's Logger needs to

diff --git a/mix.exs b/mix.exs
@@ -3,7 +3,7 @@ defmodule Jerboa.Mixfile do
 
   def project do
     [app: :jerboa,
-     version: "0.2.0",
+     version: "0.3.0",
      name: "Jerboa",
      description: "STUN/TURN encoder, decoder and client library",
      source_url: "https://github.com/esl/jerboa",