No OneTemporary
Actions

Size

1 KB

Referenced Files

None

Subscribers

None

View Options

	diff --git a/README.md b/README.md
	index c6d0cda..526d6c0 100644
	--- a/README.md
	+++ b/README.md
	@@ -1,21 +1,33 @@
	# PrometheusPhx

	-TODO: Add description
	+A Phoenix 1.5+ telemetry handler for Prometheus

	-## Installation
	+## Getting Started

	-If [available in Hex](https://hex.pm/docs/publish), the package can be installed
	-by adding `prometheus_phx` to your list of dependencies in `mix.exs`:
	+You can add PrometheusPhx as a dependency in your `mix.exs` file. In Phoenix 1.5 the telemetry instrumentation was changed and events have to be handled. This prevents libraries like `prometheus-phoenix` from working with newer versions of phoenix. So there are some minimum requirements. PrometheusPhx does require Elixir 1.7 or greater and Phoenix 1.5 or greater.

	```elixir
	def deps do
	- [
	- {:prometheus_phx, "~> 0.1.0"}
	- ]
	+ [ { :prometheus_phx, github: "theblitzapp/prometheus-phx" } ]
	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/prometheus_phx](https://hexdocs.pm/prometheus_phx).
	+After running `mix deps.get` you can add the prometheus-phx setup call to your application module.

	+```
	+defmodule MyPhoenixApp.Application do
	+ use Application
	+
	+ def start(_type, _args) do
	+ children = [
	+ MyPhoenixApp.Endpoint.
	+ ...
	+ ]
	+
	+ PrometheusPhx.setup()
	+
	+ Supervisor.start_link(children, [])
	+ end
	+end
	+
	+```