Add better docs configuration and ISC license

Author: jclem

LICENSE.md

@@ -0,0 +1,15 @@
+# ISC License
+
+Copyright 2017 Jonathan Clem
+
+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.

lib/ot/type.ex

@@ -1,6 +1,6 @@
 defmodule OT.Type do
   @moduledoc """
-  A behaviour for implementing an operational transformationt type.
+  A behaviour for implementing an operational transformation type.
 
   An operational transformation (OT) type is a module that is able to apply
   operations on a piece of data in any order and guarantee convergence of the

mix.exs

@@ -1,9 +1,14 @@
 defmodule Ot.Mixfile do
   use Mix.Project
 
+  @version "0.1.0"
+  @github_url "https://github.com/jclem/ot"
+
   def project do
     [app: :ot,
-     version: "0.1.0",
+     version: @version,
+     description: description(),
+     package: package(),
      elixir: "~> 1.4",
      build_embedded: Mix.env == :prod,
      start_permanent: Mix.env == :prod,
@@ -12,33 +17,46 @@ defmodule Ot.Mixfile do
      dialyzer: [flags: ~w(-Werror_handling
                           -Wrace_conditions
                           -Wunderspecs
-                          -Wunmatched_returns)]]
+                          -Wunmatched_returns)],
+
+      # Docs
+      name: "OT",
+      homepage_url: @github_url,
+      source_url: @github_url,
+      docs: docs()]
+  end
+
+  defp aliases do
+    [lint: ["credo", "dialyzer --halt-exit-status"]]
   end
 
-  # Configuration for the OTP application
-  #
-  # Type "mix help compile.app" for more information
   def application do
     # Specify extra applications you'll use from Erlang/Elixir
     []
   end
 
-  # Dependencies can be Hex packages:
-  #
-  #   {:my_dep, "~> 0.3.0"}
-  #
-  # Or git/path repositories:
-  #
-  #   {:my_dep, git: "https://github.com/elixir-lang/my_dep.git", tag: "0.1.0"}
-  #
-  # Type "mix help deps" for more examples and options
   defp deps do
     [{:ex_doc, "~> 0.14", only: [:dev]},
      {:dialyxir, "~> 0.4", only: [:dev], runtime: false},
      {:credo, "~> 0.5", only: [:dev, :test]}]
   end
 
-  defp aliases do
-    [lint: ["credo", "dialyzer --halt-exit-status"]]
+  defp description do
+    """
+    OT provides libraries for operational transformation, which is a method of
+    achieving consistency in a collaborative software system.
+    """
+  end
+
+  defp docs do
+    [source_ref: "v#{@version}",
+     extras: ["README.md": [filename: "README.md", title: "Readme"],
+              "LICENSE.md": [filename: "LICENSE.md", title: "License"]]]
+  end
+
+  defp package do
+    [maintainers: ["Jonathan Clem <[email protected]>"],
+     licenses: ["ISC"],
+     links: %{"GitHub" => @github_url}]
   end
 end