Merge 316b065 into 4a4b615

.gitignore

@@ -18,6 +18,9 @@ rel/
 # Ignore coverage.
 cover/
 
+# Ignore documentation.
+docs/
+
 # Ignore crash dumps.
 erl_crash.dump
 

.travis.yml

@@ -1,5 +1,18 @@
+sudo: false
 language: elixir
 elixir:
   - 1.2.3
 otp_release:
   - 18.2.1
+script:
+  - mix test
+after_script:
+  - MIX_ENV=test mix coveralls.travis
+  - mix deps.get --only docs
+  - MIX_ENV=docs mix inch.report
+notifications:
+  email:
+    recipients:
+      - m.t.williams@live.com
+    on_success: change
+    on_failure: change

README.md

@@ -1,18 +1,21 @@
 # Xe
 
+[![Continuous Integration](https://img.shields.io/travis/paulodiniz/xe/master.svg)](https://travis-ci.org/paulodiniz/xe)
+[![Code Coverage](https://img.shields.io/coveralls/paulodiniz/xe/master.svg)](https://coveralls.io/github/paulodiniz/xe)
+[![Documentation](http://inch-ci.org/github/paulodiniz/xe.svg)](http://inch-ci.org/github/paulodiniz/xe)
+[![Package](https://img.shields.io/hexpm/dt/xe.svg)](https://hex.pm/packages/xe)
+
 Xe is a dead-simple way of converting between currencies. It uses real-time conversion rates from [Xe.com](http://www.xe.com)
 
 ## Example
 
 ```elixir
-  iex(1)> Xe.rates("USD", "BRL")
+  iex(1)> Xe.rates("USD", "EUR")
   {:ok, {1.00, 0.891482}}
 ```
 
 ## Installation
 
-Standard routine:
-
   1. Add `xe` to your list of dependencies in `mix.exs`:
 
   ```elixir
@@ -21,11 +24,6 @@ Standard routine:
   end
   ```
 
-  2. Ensure `xe` is started before your application:
-
-  ```elixir
-  def application do
-    [applications: [:xe]]
-  end
-  ```
+  2. Drink your :tea:
 
+  3. Enjoy!

lib/xe/fetcher.ex

@@ -1,6 +1,5 @@
 defmodule Xe.Fetcher do
-  @moduledoc ~S"""
-  """
+  @moduledoc false
 
   # Make the base url we use to fetch rates from overridable so we can use mock
   # edpoints for end-to-end testing.

lib/xe/parser.ex

@@ -1,6 +1,5 @@
 defmodule Xe.Parser do
-  @moduledoc ~S"""
-  """
+  @moduledoc false
 
   def parse(body) do
     body

mix.exs

@@ -15,7 +15,8 @@ defmodule Xe.Mixfile do
      deps: deps,
      escript: escript_config,
      package: package,
-     docs: docs]
+     docs: docs,
+     test_coverage: [tool: ExCoveralls]]
   end
 
   def application do
@@ -42,13 +43,19 @@ defmodule Xe.Mixfile do
   defp elixirc_paths(_), do: elixirc_paths
   defp elixirc_paths, do: ~w(lib)
 
-  defp deps do
-    [{:decimal, "~> 1.0"},
-     {:httpoison, "~> 0.8"},
-     {:floki, "~> 0.7"},
-     {:ex_doc, "~> 0.10", only: :docs},
-     {:earmark, "~> 0.1", only: :docs}]
-  end
+  defp deps do [
+    {:decimal, "~> 1.0"},
+    {:httpoison, "~> 0.8"},
+    {:floki, "~> 0.7"},
+
+    # Testing
+    {:excoveralls, "~> 0.4", only: :test},
+
+    # Documentation
+    {:ex_doc, "~> 0.10", only: :docs},
+    {:earmark, "~> 0.1", only: :docs},
+    {:inch_ex, ">= 0.0.0", only: :docs}
+  ] end
 
   defp escript_config do
     [main_module: Xe.CLI]

mix.lock

@@ -1,10 +1,17 @@
 %{"certifi": {:hex, :certifi, "0.4.0"},
   "decimal": {:hex, :decimal, "1.1.1"},
+  "earmark": {:hex, :earmark, "0.2.1"},
+  "ex_doc": {:hex, :ex_doc, "0.11.4"},
+  "excoveralls": {:hex, :excoveralls, "0.5.1"},
+  "exjsx": {:hex, :exjsx, "3.2.0"},
   "floki": {:hex, :floki, "0.8.0"},
   "hackney": {:hex, :hackney, "1.5.7"},
   "httpoison": {:hex, :httpoison, "0.8.2"},
   "idna": {:hex, :idna, "1.2.0"},
+  "inch_ex": {:hex, :inch_ex, "0.5.1"},
+  "jsx": {:hex, :jsx, "2.6.2"},
   "metrics": {:hex, :metrics, "1.0.1"},
   "mimerl": {:hex, :mimerl, "1.0.2"},
   "mochiweb_html": {:hex, :mochiweb_html, "2.13.0"},
+  "poison": {:hex, :poison, "2.1.0"},
   "ssl_verify_fun": {:hex, :ssl_verify_fun, "1.1.0"}}