add changelog and restructure mix.exs

CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+## v0.3.0
+
+Fix ordering of rows and columns for keypads to match Adafruit specs. Thanks
+@chrisben and @benrom!
+
+## v0.2.0
+
+Add input to state to support native store of keypresses
+
+## v0.1.0
+
+Initial release

mix.exs

@@ -1,25 +1,25 @@
 defmodule Keypad.MixProject do
   use Mix.Project
 
+  @version "0.3.0"
+  @source_url "https://github.com/jjcarstens/keypad"
+
   def project do
     [
       app: :keypad,
-      version: "0.3.0",
+      version: @version,
       elixir: "~> 1.8",
-      name: "Keypad",
       description: "A small library to interact with keypads connected to GPIO pins",
-      source_url: "https://github.com/jjcarstens/keypad",
-      docs: [extras: ["README.md", "CONFIGURATION.md", "SETUP.md"], main: "readme"],
+      docs: docs(),
       start_permanent: Mix.env() == :prod,
       aliases: [docs: ["docs", &copy_images/1]],
-      package: [
-        maintainers: ["Jon Carstens"],
-        licenses: ["Apache License 2.0"],
-        links: %{
-          "GitHub" => "https://github.com/jjcarstens/keypad"
-        }
-      ],
-      deps: deps()
+      package: package(),
+      deps: deps(),
+      preferred_cli_env: [
+        docs: :docs,
+        "hex.build": :docs,
+        "hex.publish": :docs
+      ]
     ]
   end
 
@@ -35,8 +35,22 @@ defmodule Keypad.MixProject do
 
   defp deps do
     [
-      {:circuits_gpio, "~> 0.3"},
-      {:ex_doc, "~> 0.19", only: :dev, runtime: false}
+      {:circuits_gpio, "~> 0.4"},
+      {:ex_doc, "~> 0.23", only: :docs, runtime: false}
+    ]
+  end
+
+  defp docs do
+    [extras: ["README.md", "CONFIGURATION.md", "SETUP.md", "CHANGELOG.md"], main: "readme",
+    source_ref: "v#{@version}",
+    source_url: @source_url,
+    skip_undefined_reference_warnings_on: ["CHANGELOG.md"]]
+  end
+
+  defp package do
+    [
+      licenses: ["Apache License 2.0"],
+      links: %{"GitHub" => @source_url}
     ]
   end
 end

mix.lock

@@ -1,10 +1,9 @@
 %{
-  "circuits_gpio": {:hex, :circuits_gpio, "0.4.5", "4d5b0f707c425fc56f03086232259f65482a3d1f1cf15335253636d0bb846446", [:make, :mix], [{:elixir_make, "~> 0.6", [hex: :elixir_make, repo: "hexpm", optional: false]}], "hexpm", "b42d28d60a6cfdfb6b21b66ab0b8c5de0ea5a32b390b61d2fe86a2ad8edb90ad"},
-  "earmark": {:hex, :earmark, "1.3.1", "73812f447f7a42358d3ba79283cfa3075a7580a3a2ed457616d6517ac3738cb9", [:mix], [], "hexpm", "000aaeff08919e95e7aea13e4af7b2b9734577b3e6a7c50ee31ee88cab6ec4fb"},
+  "circuits_gpio": {:hex, :circuits_gpio, "0.4.6", "e4c37e49f5f76d662db90f9c4bcf51d6537681bb0dd2a00238598eb35b15e084", [:make, :mix], [{:elixir_make, "~> 0.6", [hex: :elixir_make, repo: "hexpm", optional: false]}], "hexpm", "cd2c9d7f16530d40218ccc2d2f727079439adf5df7bacc90c5a6197b40b06e9b"},
   "earmark_parser": {:hex, :earmark_parser, "1.4.10", "6603d7a603b9c18d3d20db69921527f82ef09990885ed7525003c7fe7dc86c56", [:mix], [], "hexpm", "8e2d5370b732385db2c9b22215c3f59c84ac7dda7ed7e544d7c459496ae519c0"},
-  "elixir_make": {:hex, :elixir_make, "0.6.0", "38349f3e29aff4864352084fc736fa7fa0f2995a819a737554f7ebd28b85aaab", [:mix], [], "hexpm", "d522695b93b7f0b4c0fcb2dfe73a6b905b1c301226a5a55cb42e5b14d509e050"},
-  "ex_doc": {:hex, :ex_doc, "0.22.2", "03a2a58bdd2ba0d83d004507c4ee113b9c521956938298eba16e55cc4aba4a6c", [:mix], [{:earmark_parser, "~> 1.4.0", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_elixir, "~> 0.14", [hex: :makeup_elixir, repo: "hexpm", optional: false]}], "hexpm", "cf60e1b3e2efe317095b6bb79651f83a2c1b3edcb4d319c421d7fcda8b3aff26"},
-  "makeup": {:hex, :makeup, "1.0.3", "e339e2f766d12e7260e6672dd4047405963c5ec99661abdc432e6ec67d29ef95", [:mix], [{:nimble_parsec, "~> 0.5", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "2e9b4996d11832947731f7608fed7ad2f9443011b3b479ae288011265cdd3dad"},
-  "makeup_elixir": {:hex, :makeup_elixir, "0.14.1", "4f0e96847c63c17841d42c08107405a005a2680eb9c7ccadfd757bd31dabccfb", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm", "f2438b1a80eaec9ede832b5c41cd4f373b38fd7aa33e3b22d9db79e640cbde11"},
-  "nimble_parsec": {:hex, :nimble_parsec, "0.6.0", "32111b3bf39137144abd7ba1cce0914533b2d16ef35e8abc5ec8be6122944263", [:mix], [], "hexpm", "27eac315a94909d4dc68bc07a4a83e06c8379237c5ea528a9acff4ca1c873c52"},
+  "elixir_make": {:hex, :elixir_make, "0.6.1", "8faa29a5597faba999aeeb72bbb9c91694ef8068f0131192fb199f98d32994ef", [:mix], [], "hexpm", "35d33270680f8d839a4003c3e9f43afb595310a592405a00afc12de4c7f55a18"},
+  "ex_doc": {:hex, :ex_doc, "0.23.0", "a069bc9b0bf8efe323ecde8c0d62afc13d308b1fa3d228b65bca5cf8703a529d", [:mix], [{:earmark_parser, "~> 1.4.0", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_elixir, "~> 0.14", [hex: :makeup_elixir, repo: "hexpm", optional: false]}], "hexpm", "f5e2c4702468b2fd11b10d39416ddadd2fcdd173ba2a0285ebd92c39827a5a16"},
+  "makeup": {:hex, :makeup, "1.0.5", "d5a830bc42c9800ce07dd97fa94669dfb93d3bf5fcf6ea7a0c67b2e0e4a7f26c", [:mix], [{:nimble_parsec, "~> 0.5 or ~> 1.0", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "cfa158c02d3f5c0c665d0af11512fed3fba0144cf1aadee0f2ce17747fba2ca9"},
+  "makeup_elixir": {:hex, :makeup_elixir, "0.15.0", "98312c9f0d3730fde4049985a1105da5155bfe5c11e47bdc7406d88e01e4219b", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}, {:nimble_parsec, "~> 1.1", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "75ffa34ab1056b7e24844c90bfc62aaf6f3a37a15faa76b07bc5eba27e4a8b4a"},
+  "nimble_parsec": {:hex, :nimble_parsec, "1.1.0", "3a6fca1550363552e54c216debb6a9e95bd8d32348938e13de5eda962c0d7f89", [:mix], [], "hexpm", "08eb32d66b706e913ff748f11694b17981c0b04a33ef470e33e11b3d3ac8f54b"},
 }