diff --git a/README.md b/README.md index 2a72081..0666071 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,10 @@ # Tower -**TODO: Add description** +Solid error handling and reporting ## Installation -If [available in Hex](https://hex.pm/docs/publish), the package can be installed -by adding `tower` to your list of dependencies in `mix.exs`: +The package can be installed by adding `tower` to your list of dependencies in `mix.exs`: ```elixir def deps do @@ -15,10 +14,6 @@ def deps do 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 . - ## License Copyright 2024 Mimiquate diff --git a/mix.exs b/mix.exs index 82453e9..f60ad55 100644 --- a/mix.exs +++ b/mix.exs @@ -1,13 +1,24 @@ defmodule Tower.MixProject do use Mix.Project + @description "Solid error handling and reporting" + @source_url "https://github.com/mimiquate/tower" + @version "0.1.0" + def project do [ app: :tower, - version: "0.1.0", + description: @description, + version: @version, elixir: "~> 1.16", start_permanent: Mix.env() == :prod, - deps: deps() + deps: deps(), + package: package(), + + # Docs + name: "Tower", + source_url: @source_url, + docs: docs() ] end @@ -21,8 +32,22 @@ defmodule Tower.MixProject do # Run "mix help deps" to learn about dependencies. defp deps do [ - # {:dep_from_hexpm, "~> 0.3.0"}, - # {:dep_from_git, git: "https://github.com/elixir-lang/my_dep.git", tag: "0.1.0"} + {:ex_doc, "~> 0.34.0", only: :dev, runtime: false} + ] + end + + defp package do + [ + licenses: ["Apache-2.0"], + links: %{ + "GitHub" => @source_url + } + ] + end + + defp docs do + [ + extras: ["README.md"] ] end end diff --git a/mix.lock b/mix.lock new file mode 100644 index 0000000..ae885bb --- /dev/null +++ b/mix.lock @@ -0,0 +1,8 @@ +%{ + "earmark_parser": {:hex, :earmark_parser, "1.4.39", "424642f8335b05bb9eb611aa1564c148a8ee35c9c8a8bba6e129d51a3e3c6769", [:mix], [], "hexpm", "06553a88d1f1846da9ef066b87b57c6f605552cfbe40d20bd8d59cc6bde41944"}, + "ex_doc": {:hex, :ex_doc, "0.34.0", "ab95e0775db3df71d30cf8d78728dd9261c355c81382bcd4cefdc74610bef13e", [:mix], [{:earmark_parser, "~> 1.4.39", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_c, ">= 0.1.0", [hex: :makeup_c, repo: "hexpm", optional: true]}, {:makeup_elixir, "~> 0.14 or ~> 1.0", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1 or ~> 1.0", [hex: :makeup_erlang, repo: "hexpm", optional: false]}, {:makeup_html, ">= 0.1.0", [hex: :makeup_html, repo: "hexpm", optional: true]}], "hexpm", "60734fb4c1353f270c3286df4a0d51e65a2c1d9fba66af3940847cc65a8066d7"}, + "makeup": {:hex, :makeup, "1.1.2", "9ba8837913bdf757787e71c1581c21f9d2455f4dd04cfca785c70bbfff1a76a3", [:mix], [{:nimble_parsec, "~> 1.2.2 or ~> 1.3", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "cce1566b81fbcbd21eca8ffe808f33b221f9eee2cbc7a1706fc3da9ff18e6cac"}, + "makeup_elixir": {:hex, :makeup_elixir, "0.16.2", "627e84b8e8bf22e60a2579dad15067c755531fea049ae26ef1020cad58fe9578", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}, {:nimble_parsec, "~> 1.2.3 or ~> 1.3", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "41193978704763f6bbe6cc2758b84909e62984c7752b3784bd3c218bb341706b"}, + "makeup_erlang": {:hex, :makeup_erlang, "1.0.0", "6f0eff9c9c489f26b69b61440bf1b238d95badae49adac77973cbacae87e3c2e", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm", "ea7a9307de9d1548d2a72d299058d1fd2339e3d398560a0e46c27dab4891e4d2"}, + "nimble_parsec": {:hex, :nimble_parsec, "1.4.0", "51f9b613ea62cfa97b25ccc2c1b4216e81df970acd8e16e8d1bdc58fef21370d", [:mix], [], "hexpm", "9c565862810fb383e9838c1dd2d7d2c437b3d13b267414ba6af33e50d2d1cf28"}, +}