Prepare version 0.1.0

CHANGELOG.md

@@ -0,0 +1,13 @@
+# Change log
+
+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.1.0 - 2017-02-21
+
+### Added
+* encoding and decoding of STUN messages format, header validation
+* encoding and decoding of XOR-MAPPED-ADDRESS attribute
+* basic STUN client utilities - sending Binding request and indication

README.md

@@ -5,8 +5,23 @@
 [![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.1.0)
 
-STUN/TURN encoder, decoder and client library
+
+STUN/TURN encoder, decoder and client library by [Erlang Solutions](https://www.erlang-solutions.com)
+
+Jerboa aims to provide simple APIs for common STUN/TURN use cases. It is used by [Fennec](https://github.com/esl/fennec)
+for encoding and decoding of STUN messages, as well as a testing tool.
+
+### Installation
+
+Jerboa is available on [Hex](https://hex.pm/packages/jerboa). To use it, just add it to your dependencies:
+
+```elixir
+def deps do
+  [{:jerboa, "~> 0.1.0"}]
+end
+```
 
 ### Checklist of STUN/TURN/ICE methods supported by Jerboa's encoder/decoder
 

mix.exs

@@ -4,12 +4,14 @@ defmodule Jerboa.Mixfile do
   def project do
     [app: :jerboa,
      version: "0.1.0",
+     name: "Jerboa",
      description: "STUN/TURN encoder, decoder and client library",
      elixir: "~> 1.4",
      elixirc_paths: elixirc_paths(Mix.env),
      build_embedded: Mix.env == :prod,
      start_permanent: Mix.env == :prod,
      deps: deps(),
+     package: package(),
      docs: docs(),
      dialyzer: dialyzer(),
      test_coverage: test_coverage(),
@@ -18,10 +20,8 @@ defmodule Jerboa.Mixfile do
 
   def application do
     [mod: {Jerboa.Client.Application, []},
-     env: [client: [timeout: 5 * 1000]
-          ],
-     extra_applications: [:logger]
-    ]
+     env: [client: [timeout: 5 * 1000]],
+     extra_applications: [:logger]]
   end
 
   defp elixirc_paths(:test), do: ["lib", "test/helper"]
@@ -36,8 +36,14 @@ defmodule Jerboa.Mixfile do
      {:quixir, "~> 0.9", runtime: false, only: :test}]
   end
 
+  defp package do
+    [licenses: ["Apache 2.0"],
+     maintainers: ["Erlang Solutions"],
+     links: %{"GitHub" => "https://github.com/esl/jerboa"}]
+  end
+
   defp docs do
-    [main: "Readme",
+    [main: "Jerboa",
      extras: ["README.md": [title: "Jerboa"]]]
   end