Refactor mix.exs, add Hexdocs config. Add mediocre X logo

README.md

@@ -6,7 +6,7 @@ to a new file/module. At this time, ExFactor cannot change the function arity.
 
 ## BETA Warning
 
-ExFactor is still in active development and the API can and will change frequently!
+ExFactor is still in active development and the API can and may change frequently!
 
 Use at your peril, _for now._
 
@@ -24,6 +24,7 @@ Use at your peril, _for now._
 
 ## Roadmap TODO
 
+  - [] How does this work with macro code? Does that even make sense as a case to handle?
   - [] Update .exs files too?
   - [] Write tests to ensure we can find modules across umbrella apps.
   - [] Add configuration hooks?

VERSION

@@ -0,0 +1 @@
+0.2.2

mix.exs

@@ -1,18 +1,25 @@
 defmodule ExFactor.MixProject do
   use Mix.Project
 
+  @name "ExFactor"
+  @source_url "https://github.com/ckochx/ex_factor"
+  @version "VERSION"
+    |> File.read!()
+    |> String.trim()
+
   def project do
     [
       app: :ex_factor,
-      name: "ExFactor",
-      version: "0.2.1",
+      name: @name,
+      version: @version,
       elixir: "~> 1.12",
       elixirc_paths: elixirc_paths(Mix.env()),
       start_permanent: Mix.env() == :prod,
       deps: deps(),
       description: description(),
+      docs: docs(),
       package: package(),
-      source_url: "https://github.com/ckochx/ex_factor"
+      source_url: @source_url
     ]
   end
 
@@ -31,14 +38,28 @@ defmodule ExFactor.MixProject do
   end
 
   defp deps do
-    []
+    [
+      {:ex_doc, ">= 0.0.0", only: :dev, runtime: false}
+    ]
   end
 
   # Run "mix help deps" to learn about dependencies.
   defp package() do
     [
       licenses: ["CC-BY-NC-ND-4.0"],
-      links: %{"GitHub" => "https://github.com/ckochx/ex_factor"}
+      links: %{"GitHub" => @source_url}
+    ]
+  end
+
+  defp docs do
+    [
+      logo: "assets/X.jpg",
+      source_ref: "v#{@version}",
+      source_url: @source_url,
+      main: @name,
+      # extras: [
+      #   "CHANGELOG.md"
+      # ]
     ]
   end
 end

mix.lock

@@ -1,2 +1,8 @@
 %{
+  "earmark_parser": {:hex, :earmark_parser, "1.4.26", "f4291134583f373c7d8755566122908eb9662df4c4b63caa66a0eabe06569b0a", [:mix], [], "hexpm", "48d460899f8a0c52c5470676611c01f64f3337bad0b26ddab43648428d94aabc"},
+  "ex_doc": {:hex, :ex_doc, "0.28.4", "001a0ea6beac2f810f1abc3dbf4b123e9593eaa5f00dd13ded024eae7c523298", [:mix], [{:earmark_parser, "~> 1.4.19", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_elixir, "~> 0.14", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1", [hex: :makeup_erlang, repo: "hexpm", optional: false]}], "hexpm", "bf85d003dd34911d89c8ddb8bda1a958af3471a274a4c2150a9c01c78ac3f8ed"},
+  "makeup": {:hex, :makeup, "1.1.0", "6b67c8bc2882a6b6a445859952a602afc1a41c2e08379ca057c0f525366fc3ca", [:mix], [{:nimble_parsec, "~> 1.2.2 or ~> 1.3", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "0a45ed501f4a8897f580eabf99a2e5234ea3e75a4373c8a52824f6e873be57a6"},
+  "makeup_elixir": {:hex, :makeup_elixir, "0.16.0", "f8c570a0d33f8039513fbccaf7108c5d750f47d8defd44088371191b76492b0b", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}, {:nimble_parsec, "~> 1.2.3", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "28b2cbdc13960a46ae9a8858c4bebdec3c9a6d7b4b9e7f4ed1502f8159f338e7"},
+  "makeup_erlang": {:hex, :makeup_erlang, "0.1.1", "3fcb7f09eb9d98dc4d208f49cc955a34218fc41ff6b84df7c75b3e6e533cc65f", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm", "174d0809e98a4ef0b3309256cbf97101c6ec01c4ab0b23e926a9e17df2077cbb"},
+  "nimble_parsec": {:hex, :nimble_parsec, "1.2.3", "244836e6e3f1200c7f30cb56733fd808744eca61fd182f731eac4af635cc6d0b", [:mix], [], "hexpm", "c8d789e39b9131acf7b99291e93dae60ab48ef14a7ee9d58c6964f59efb570b0"},
 }