Prepare for v0.1.0 release

LICENSE.md

@@ -0,0 +1,15 @@
+# ISC License
+
+Copyright © 2017, Boulevard Labs, Inc.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

README.md

@@ -2,22 +2,29 @@
 
 [![Build Status][semaphore-badge]][semaphore]
 
-**TODO: Add description**
+**QuickBooks Online API client for Elixir.**
+
+Everything is still a work in progress. Only authentication (through OAuth 1.0)
+is supported right now.
 
 ## Installation
 
-If [available in Hex](https://hex.pm/docs/publish), the package can be installed
-by adding `exquickbooks` to your list of dependencies in `mix.exs`:
+The package can be installed by adding `exquickbooks` to your list of
+dependencies in `mix.exs`:
 
 ```elixir
 def deps do
   [{:exquickbooks, "~> 0.1.0"}]
 end
 ```
 
-Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
-and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
-be found at [https://hexdocs.pm/exquickbooks](https://hexdocs.pm/exquickbooks).
+The docs can be found at <https://hexdocs.pm/exquickbooks>.
+
+## Development
+
+1. Write tests.
+2. Write code. Test with `mix test`.
+3. See tests. See tests run. Run tests, run!
 
 [semaphore]: https://semaphoreci.com/boulevard/exquickbooks
 [semaphore-badge]: https://semaphoreci.com/api/v1/projects/19242d95-e2d6-4ef1-9fd3-85108a098b94/1200409/badge.svg

mix.exs

@@ -5,10 +5,14 @@ defmodule ExQuickBooks.Mixfile do
     [app: :exquickbooks,
      version: "0.1.0",
      elixir: "~> 1.4",
+     description: description(),
+     package: package(),
+     deps: deps(),
      elixirc_paths: elixirc_paths(Mix.env),
      build_embedded: Mix.env == :prod,
      start_permanent: Mix.env == :prod,
-     deps: deps()]
+     test_coverage: [tool: ExCoveralls],
+     preferred_cli_env: [coveralls: :test]]
   end
 
   # Configuration for the OTP application
@@ -19,6 +23,22 @@ defmodule ExQuickBooks.Mixfile do
      extra_applications: [:logger, :httpoison]]
   end
 
+  defp env do
+    [backend: ExQuickBooks.HTTPoisonBackend]
+  end
+
+  defp description do
+    """
+    QuickBooks Online API client for Elixir.
+    """
+  end
+
+  defp package do
+    [licenses: ["ISC"],
+     maintainers: ["Boulevard Labs, Inc."],
+     links: %{"GitHub" => "https://github.com/Boulevard/ExQuickBooks"}]
+  end
+
   # Dependencies can be Hex packages:
   #
   #   {:my_dep, "~> 0.3.0"}
@@ -29,14 +49,10 @@ defmodule ExQuickBooks.Mixfile do
   #
   # Type "mix help deps" for more examples and options
   defp deps do
-    [
-      {:httpoison, "~> 0.10.0"},
-      {:oauther, "~> 1.1"}
-    ]
-  end
-
-  defp env do
-    [backend: ExQuickBooks.HTTPoisonBackend]
+    [{:httpoison, "~> 0.11"},
+     {:oauther, "~> 1.1"},
+     {:ex_doc, "~> 0.14", only: :dev},
+     {:excoveralls, "~> 0.6", only: :test}]
   end
 
   defp elixirc_paths(:test),  do: ["lib", "test/support"]

mix.lock

@@ -1,7 +1,12 @@
 %{"certifi": {:hex, :certifi, "1.0.0", "1c787a85b1855ba354f0b8920392c19aa1d06b0ee1362f9141279620a5be2039", [:rebar3], []},
-  "hackney": {:hex, :hackney, "1.6.6", "5564b4695d48fd87859e9df77a7fa4b4d284d24519f0cd7cc898f09e8fbdc8a3", [:rebar3], [{:certifi, "1.0.0", [hex: :certifi, optional: false]}, {:idna, "4.0.0", [hex: :idna, optional: false]}, {:metrics, "1.0.1", [hex: :metrics, optional: false]}, {:mimerl, "1.0.2", [hex: :mimerl, optional: false]}, {:ssl_verify_fun, "1.1.1", [hex: :ssl_verify_fun, optional: false]}]},
-  "httpoison": {:hex, :httpoison, "0.10.0", "4727b3a5e57e9a4ff168a3c2883e20f1208103a41bccc4754f15a9366f49b676", [:mix], [{:hackney, "~> 1.6.3", [hex: :hackney, optional: false]}]},
+  "earmark": {:hex, :earmark, "1.1.1", "433136b7f2e99cde88b745b3a0cfc3fbc81fe58b918a09b40fce7f00db4d8187", [:mix], []},
+  "ex_doc": {:hex, :ex_doc, "0.15.0", "e73333785eef3488cf9144a6e847d3d647e67d02bd6fdac500687854dd5c599f", [:mix], [{:earmark, "~> 1.1", [hex: :earmark, optional: false]}]},
+  "excoveralls": {:hex, :excoveralls, "0.6.2", "0e993d096f1fbb6e70a3daced5c89aac066bda6bce57829622aa2d1e2b338cfb", [:mix], [{:exjsx, "~> 3.0", [hex: :exjsx, optional: false]}, {:hackney, ">= 0.12.0", [hex: :hackney, optional: false]}]},
+  "exjsx": {:hex, :exjsx, "3.2.1", "1bc5bf1e4fd249104178f0885030bcd75a4526f4d2a1e976f4b428d347614f0f", [:mix], [{:jsx, "~> 2.8.0", [hex: :jsx, optional: false]}]},
+  "hackney": {:hex, :hackney, "1.7.1", "e238c52c5df3c3b16ce613d3a51c7220a784d734879b1e231c9babd433ac1cb4", [:rebar3], [{:certifi, "1.0.0", [hex: :certifi, optional: false]}, {:idna, "4.0.0", [hex: :idna, optional: false]}, {:metrics, "1.0.1", [hex: :metrics, optional: false]}, {:mimerl, "1.0.2", [hex: :mimerl, optional: false]}, {:ssl_verify_fun, "1.1.1", [hex: :ssl_verify_fun, optional: false]}]},
+  "httpoison": {:hex, :httpoison, "0.11.1", "d06c571274c0e77b6cc50e548db3fd7779f611fbed6681fd60a331f66c143a0b", [:mix], [{:hackney, "~> 1.7.0", [hex: :hackney, optional: false]}]},
   "idna": {:hex, :idna, "4.0.0", "10aaa9f79d0b12cf0def53038547855b91144f1bfcc0ec73494f38bb7b9c4961", [:rebar3], []},
+  "jsx": {:hex, :jsx, "2.8.2", "7acc7d785b5abe8a6e9adbde926a24e481f29956dd8b4df49e3e4e7bcc92a018", [:mix, :rebar3], []},
   "metrics": {:hex, :metrics, "1.0.1", "25f094dea2cda98213cecc3aeff09e940299d950904393b2a29d191c346a8486", [:rebar3], []},
   "mimerl": {:hex, :mimerl, "1.0.2", "993f9b0e084083405ed8252b99460c4f0563e41729ab42d9074fd5e52439be88", [:rebar3], []},
   "oauther": {:hex, :oauther, "1.1.0", "c9a56e200507ce64e069f5273143db0cddd7904cd5d1fe46920388a48f22441b", [:mix], []},