Misc doc changes (#47)

Besides other documentation changes, this commit ensures the generated
HTML doc for HexDocs.pm will become the main source doc for this Elixir
library which leverage on latest ExDoc features.

.gitignore

@@ -22,3 +22,5 @@ erl_crash.dump
 # Ignore package tarball (built via "mix hex.build").
 spandex_phoenix-*.tar
 
+# Temporary files for e.g. tests.
+/tmp/

CHANGELOG.md

@@ -1,4 +1,4 @@
-# Change Log
+# Changelog
 
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
@@ -75,13 +75,13 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
 
 ## [v0.3.1](https://github.com/spandex-project/spandex_phoenix/compare/0.3.0...v0.3.1) (2018-12-20)
 
-## Bug Fixes:
+### Bug Fixes:
 
 - Configure tracer runtime instead of compile time
 
 ## [v0.3.0](https://github.com/spandex-project/spandex_phoenix/compare/0.2.1...v0.2.1) (2018-11-19)
 
-## Bug Fixes:
+### Bug Fixes:
 
 - Return a conn when the request is filtered
 

README.md

@@ -1,21 +1,22 @@
 # SpandexPhoenix
-[![CircleCI](https://circleci.com/gh/spandex-project/spandex_phoenix.svg?style=svg)](https://circleci.com/gh/spandex-project/spandex_phoenix)
-[![Inline docs](http://inch-ci.org/github/spandex-project/spandex_phoenix.svg)](http://inch-ci.org/github/spandex-project/spandex_phoenix)
-[![Coverage Status](https://coveralls.io/repos/github/spandex-project/spandex_phoenix/badge.svg)](https://coveralls.io/github/spandex-project/spandex_phoenix)
-[![Hex pm](http://img.shields.io/hexpm/v/spandex_phoenix.svg?style=flat)](https://hex.pm/packages/spandex_phoenix)
-[![SourceLevel](https://sourcelevel.io/github/spandex-project/spandex_phoenix.svg)](https://sourcelevel.io/github/spandex-project/spandex_phoenix)
 
-Phoenix and Plug integrations for the
-[Spandex](https://github.com/spandex-project/spandex) tracing library.
+[![Hex Version](https://img.shields.io/hexpm/v/spandex_phoenix.svg)](https://hex.pm/packages/spandex_phoenix)
+[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/spandex_phoenix/)
+[![Total Downloads](https://img.shields.io/hexpm/dt/spandex_phoenix.svg)](https://hex.pm/packages/spandex_phoenix)
+[![License](https://img.shields.io/hexpm/l/spandex_phoenix.svg)](https://github.com/spandex-project/spandex_phoenix/blob/master/LICENSE)
+
+Phoenix and Plug integrations for the [Spandex] tracing library.
+
+[Spandex]: https://github.com/spandex-project/spandex
 
 ## Usage
 
-Add `spandex_phoenix` to your dendencies in `mix.exs`:
+Add `:spandex_phoenix` to your dependencies in `mix.exs`:
 
 ```elixir
 def deps do
   [
-    {:spandex_phoenix, "~> 1.0.5"}
+    {:spandex_phoenix, "~> 1.0"}
   ]
 end
 ```
@@ -68,11 +69,13 @@ end
 ```
 
 If you use Phoenix, you don't need to use the following integration most likely, otherwise, you get the error messages like
+
 ```
 [error] Tried to start a trace over top of another trace
 ```
 
 Plug integration:
+
 ```elixir
 defmodule MyApp.Router do
   use Plug.Router
@@ -109,5 +112,11 @@ config :my_app, MyAppWeb.Endpoint,
 
 More details can also be found in the docs on [Hexdocs].
 
+## Copyright and License
+
+Copyright (c) 2021 Zachary Daniel & Greg Mefford
+
+Released under the MIT License, which can be found in [LICENSE.md](./LICENSE.md).
+
 [Hexdocs]: https://hexdocs.pm/spandex_phoenix
 [documentation for SpandexPhoenix]: https://hexdocs.pm/spandex_phoenix/SpandexPhoenix.html

mix.exs

@@ -2,6 +2,7 @@ defmodule SpandexPhoenix.MixProject do
   use Mix.Project
 
   @version "1.0.6"
+  @source_url "https://github.com/spandex-project/spandex_phoenix"
 
   def project do
     [
@@ -12,7 +13,6 @@ defmodule SpandexPhoenix.MixProject do
       compilers: compilers(Mix.env()),
       start_permanent: Mix.env() == :prod,
       package: package(),
-      description: description(),
       docs: docs(),
       deps: deps(),
       test_coverage: [tool: ExCoveralls],
@@ -28,11 +28,13 @@ defmodule SpandexPhoenix.MixProject do
 
   defp package do
     [
+      description: "Tools for integrating Phoenix with Spandex.",
       name: :spandex_phoenix,
       maintainers: ["Greg Mefford"],
-      licenses: ["MIT License"],
+      licenses: ["MIT"],
       links: %{
-        "GitHub" => "https://github.com/spandex-project/spandex_phoenix",
+        "Changelog" => "https://hexdocs.pm/spandex_phoenix/changelog.html",
+        "GitHub" => @source_url,
         "Sponsor" => "https://github.com/sponsors/GregMefford"
       }
     ]
@@ -44,18 +46,17 @@ defmodule SpandexPhoenix.MixProject do
   defp compilers(:test), do: [:phoenix] ++ Mix.compilers()
   defp compilers(_), do: Mix.compilers()
 
-  defp description() do
-    """
-    Tools for integrating Phoenix with Spandex.
-    """
-  end
-
   defp docs do
     [
-      main: "readme",
       extras: [
-        "README.md"
-      ]
+        "CHANGELOG.md",
+        {:"LICENSE.md", [title: "License"]},
+        {:"README.md", [title: "Overview"]}
+      ],
+      main: "readme",
+      source_url: @source_url,
+      source_ref: "v#{@version}",
+      formatters: ["html"]
     ]
   end