Prepare release

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2023 Bizneo Solutions S.L.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,21 +1,33 @@
 # Metro
 
-**TODO: Add description**
+This package provides basic Prometheus metrics of Erlang VM and Ecto for Elixir projects.
+
+It exposes a new endpoint in a different port with the Prometheus endpoint at `/metrics`.
 
 ## Installation
 
-If [available in Hex](https://hex.pm/docs/publish), the package can be installed
-by adding `metro` to your list of dependencies in `mix.exs`:
+The package can be installed by adding `metro` to your list of dependencies in `mix.exs`:
 
 ```elixir
 def deps do
   [
-    {:metro, "~> 0.1.0"}
+    {:metro, "~> 0.1.0"},
   ]
 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 <https://hexdocs.pm/metro>.
+After that, you need to start Metro within your application:
+
+```elixir
+defmodule MyApp.Application do
+  def start(_type, _args) do
+    children = [
+      # Start metrics
+      {Metro, app: :my_app, port: 9000}
+    ]
+  end
+end
+```
 
+and metrics will be available at `http://localhost:9000/metrics` once you start
+your application.

mix.exs

@@ -1,13 +1,36 @@
 defmodule Metro.MixProject do
   use Mix.Project
 
+  @source_url "https://github.com/bizneo/metro"
+  @version "0.1.0"
+
   def project do
     [
       app: :metro,
-      version: "0.1.0",
-      elixir: "~> 1.15",
+      version: @version,
+      elixir: "~> 1.10",
       start_permanent: Mix.env() == :prod,
-      deps: deps()
+      deps: deps(),
+      description: description(),
+      package: package()
+    ]
+  end
+
+  defp description do
+    """
+    Plug and play Prometheus metrics of Erlang VM and Ecto for Elixir projects.
+    """
+  end
+
+  defp package do
+    [
+      maintainers: ["Bizneo Solutions"],
+      licenses: ["MIT"],
+      source_url: @source_url,
+      files: ~w(lib .formatter.exs mix.exs README* LICENSE*),
+      links: %{
+        "GitHub" => @source_url
+      }
     ]
   end