Added CHANGELOG.md

Author: bryanjos

.gitignore

@@ -2,3 +2,4 @@
 /deps
 erl_crash.dump
 *.ez
+/doc

CHANGELOG.md

@@ -0,0 +1,3 @@
+## [1.0.0]
+### Added
+- First release

README.md

@@ -1,12 +1,12 @@
 Diff
 ====
 
-A diff library in Elixir
+A simple diff library in Elixir
 
 
 ## Diff.diff
 
-Compares 2 binaries and returns a list of changes from the first given binary with the second
+Compares 2 terms that have an implementation of the `Diff.Diffable` protocol and returns a list of changes from the first given binary with the second
 
 The diff function can take the following options:
 
@@ -24,7 +24,7 @@ iex(1)> Diff.diff("test", "taste")
 
 ## Diff.patch
 
-Applies the given patches to the binary. Takes an optional third parameter to turn
+Applies the given patches to the term. Takes an optional third parameter to turn
 the patched list created from applying the patches back into the type needed.
 
 
@@ -47,3 +47,7 @@ iex(1)> patches = Diff.diff("test", "taste")
 iex(2)> Diff.patch("test", patches, &Enum.join/1)
 "taste"
 ```
+
+
+`Diff.diff` and `Diff.patch` both take as a first parameter a term that has an implementation of the `Diff.Diffable` protocol.
+By default one exist for `BitString` and `List`

lib/diff/diffable.ex

@@ -1,15 +1,19 @@
 defprotocol Diff.Diffable do
+  @moduledoc """
+  Protocol used by `Diff` module to turn input into a list
+  to calculate diffs
+  """
   def to_list(diffable)
 end
 
 defimpl Diff.Diffable, for: BitString do
   def to_list(diffable) do
     String.graphemes(diffable)
   end
+end
 
-  defimpl Diff.Diffable, for: List do
-    def to_list(diffable) do
-      diffable
-    end
+defimpl Diff.Diffable, for: List do
+  def to_list(diffable) do
+    diffable
   end
 end

lib/diff/matrix.ex

@@ -1,4 +1,5 @@
 defmodule Diff.Matrix do
+  @moduledoc false
 
   def new(rows, columns) do
     List.duplicate(List.duplicate(0, columns), rows)
@@ -8,11 +9,11 @@ defmodule Diff.Matrix do
     list = Enum.fetch!(matrix, i)
     Enum.fetch!(list, j)
   end
-  
+
   def put(matrix, i, j, new_value) do
     list = Enum.fetch!(matrix, i)
     list = List.update_at(list, j, fn(_) -> new_value end)
-    List.update_at(matrix, i,  fn(_) -> list end) 
+    List.update_at(matrix, i,  fn(_) -> list end)
   end
 
 end

mix.exs

@@ -3,30 +3,43 @@ defmodule Diff.Mixfile do
 
   def project do
     [app: :diff,
-     version: "0.0.1",
+     name: "Diff",
+     version: "1.0.0",
      elixir: "~> 1.0",
+     description: description,
+     package: package,
+     source_url: "https://github.com/bryanjos/diff",
      build_embedded: Mix.env == :prod,
      start_permanent: Mix.env == :prod,
      deps: deps]
   end
 
-  # Configuration for the OTP application
-  #
-  # Type `mix help compile.app` for more information
   def application do
     [applications: [:logger]]
   end
 
-  # Dependencies can be Hex packages:
-  #
-  #   {:mydep, "~> 0.3.0"}
-  #
-  # Or git/path repositories:
-  #
-  #   {:mydep, git: "https://github.com/elixir-lang/mydep.git", tag: "0.1.0"}
-  #
-  # Type `mix help deps` for more examples and options
   defp deps do
-    []
+    [
+      {:earmark, "~> 0.2", only: :dev },
+      {:ex_doc, "~> 0.11", only: :dev },
+      {:credo, "~> 0.2.0", only: :dev }
+    ]
+  end
+
+  defp description do
+  """
+  A simple diff library
+  """
+  end
+
+  defp package do
+    [
+      files: ["lib", "mix.exs", "README*", "LICENSE*", "CHANGELOG*"],
+      maintainers: ["Bryan Joseph"],
+      licenses: ["MIT"],
+      links: %{
+        "GitHub" => "https://github.com/bryanjos/diff"
+      }
+    ]
   end
 end

mix.lock

@@ -0,0 +1,4 @@
+%{"bunt": {:hex, :bunt, "0.1.5"},
+  "credo": {:hex, :credo, "0.2.6"},
+  "earmark": {:hex, :earmark, "0.2.1"},
+  "ex_doc": {:hex, :ex_doc, "0.11.4"}}