Skip to content

Commit

Permalink
Prep for 0.1.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
GregMefford committed Sep 15, 2018
1 parent 62fcddc commit 232141b
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 9 deletions.
4 changes: 0 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,16 +27,12 @@ end
Configure it to use your desired `Spandex.Tracer` module in `config.exs`:

```elixir
use Mix.Config

config :spandex_phoenix, tracer: MyApp.Tracer
```

Configure your Phoenix `Endpoint` to use this library as an `instrumenter`:

```elixir
use Mix.Config

config :my_app, MyAppWeb.Endpoint,
# ... existing config ...
instrumenters: [SpandexPhoenix.Instrumenter]
Expand Down
3 changes: 2 additions & 1 deletion lib/spandex_phoenix/instrumenter.ex
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
defmodule SpandexPhoenix.Instrumenter do
@moduledoc """
Phoenix instrumenter callback module
Phoenix instrumenter callback module.
More details can be found in [the Phoenix documentation](https://hexdocs.pm/phoenix/Phoenix.Endpoint.html#module-phoenix-default-events).
"""

@tracer Application.get_env(:spandex_phoenix, :tracer) || raise "You must configure a :tracer for :spandex_phoenix"
Expand Down
12 changes: 11 additions & 1 deletion mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ defmodule SpandexPhoenix.MixProject do
start_permanent: Mix.env() == :prod,
package: package(),
description: description(),
docs: docs(),
deps: deps()
]
end
Expand All @@ -34,11 +35,20 @@ defmodule SpandexPhoenix.MixProject do
"""
end

defp docs do
[
main: "readme",
extras: [
"README.md"
]
]
end

defp deps do
[
{:ex_doc, ">= 0.0.0", only: :dev},
{:phoenix, "~> 1.0"},
{:spandex, "~> 2.2"}
{:spandex, "~> 2.0"}
]
end
end
9 changes: 6 additions & 3 deletions mix.lock
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
%{
"earmark": {:hex, :earmark, "1.2.6", "b6da42b3831458d3ecc57314dff3051b080b9b2be88c2e5aa41cd642a5b044ed", [:mix], [], "hexpm"},
"ex_doc": {:hex, :ex_doc, "0.19.1", "519bb9c19526ca51d326c060cb1778d4a9056b190086a8c6c115828eaccea6cf", [:mix], [{:earmark, "~> 1.1", [hex: :earmark, repo: "hexpm", optional: false]}, {:makeup_elixir, "~> 0.7", [hex: :makeup_elixir, repo: "hexpm", optional: false]}], "hexpm"},
"makeup": {:hex, :makeup, "0.5.4", "71fbff7079cf2a6371cae11f193233842300a895c8de9d97e09c39a5d77d1f0d", [:mix], [{:nimble_parsec, "~> 0.4", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm"},
"makeup_elixir": {:hex, :makeup_elixir, "0.8.1", "54a4deadaa0c6b6d467362fea29ac002420b083eb2484d9e1aa13931dbc22b58", [:mix], [{:makeup, "~> 0.5.4", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm"},
"makeup": {:hex, :makeup, "0.5.5", "9e08dfc45280c5684d771ad58159f718a7b5788596099bdfb0284597d368a882", [:mix], [{:nimble_parsec, "~> 0.4", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm"},
"makeup_elixir": {:hex, :makeup_elixir, "0.8.2", "ecc130aaf3645d142f50ccd4c727f714afdb490062dcaf009f4c2d86332d1beb", [:mix], [{:makeup, "~> 0.5.5", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm"},
"mime": {:hex, :mime, "1.3.0", "5e8d45a39e95c650900d03f897fbf99ae04f60ab1daa4a34c7a20a5151b7a5fe", [:mix], [], "hexpm"},
"nimble_parsec": {:hex, :nimble_parsec, "0.4.0", "ee261bb53214943679422be70f1658fff573c5d0b0a1ecd0f18738944f818efe", [:mix], [], "hexpm"},
"optimal": {:hex, :optimal, "0.3.6", "46bbf52fbbbd238cda81e02560caa84f93a53c75620f1fe19e81e4ae7b07d1dd", [:mix], [], "hexpm"},
"plug": {:hex, :plug, "1.6.2", "e06a7bd2bb6de5145da0dd950070110dce88045351224bd98e84edfdaaf5ffee", [:mix], [{:cowboy, "~> 1.0.1 or ~> 1.1 or ~> 2.4", [hex: :cowboy, repo: "hexpm", optional: true]}, {:mime, "~> 1.0", [hex: :mime, repo: "hexpm", optional: false]}], "hexpm"},
"phoenix": {:hex, :phoenix, "1.3.4", "aaa1b55e5523083a877bcbe9886d9ee180bf2c8754905323493c2ac325903dc5", [:mix], [{:cowboy, "~> 1.0", [hex: :cowboy, repo: "hexpm", optional: true]}, {:phoenix_pubsub, "~> 1.0", [hex: :phoenix_pubsub, repo: "hexpm", optional: false]}, {:plug, "~> 1.3.3 or ~> 1.4", [hex: :plug, repo: "hexpm", optional: false]}, {:poison, "~> 2.2 or ~> 3.0", [hex: :poison, repo: "hexpm", optional: false]}], "hexpm"},
"phoenix_pubsub": {:hex, :phoenix_pubsub, "1.1.0", "d55e25ff1ff8ea2f9964638366dfd6e361c52dedfd50019353598d11d4441d14", [:mix], [], "hexpm"},
"plug": {:hex, :plug, "1.6.3", "43088304337b9e8b8bd22a0383ca2f633519697e4c11889285538148f42cbc5e", [:mix], [{:cowboy, "~> 1.0.1 or ~> 1.1 or ~> 2.4", [hex: :cowboy, repo: "hexpm", optional: true]}, {:mime, "~> 1.0", [hex: :mime, repo: "hexpm", optional: false]}], "hexpm"},
"poison": {:hex, :poison, "3.1.0", "d9eb636610e096f86f25d9a46f35a9facac35609a7591b3be3326e99a0484665", [:mix], [], "hexpm"},
"spandex": {:hex, :spandex, "2.2.0", "0d60e2a232074ebf6e299edcd3ee540df87541246ba5f5bd84c68a9bb00171bc", [:mix], [{:optimal, "~> 0.3.3", [hex: :optimal, repo: "hexpm", optional: false]}, {:plug, ">= 1.0.0", [hex: :plug, repo: "hexpm", optional: false]}], "hexpm"},
}

0 comments on commit 232141b

Please sign in to comment.