Misc doc changes

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

Author: kianmeng

.gitignore

@@ -7,7 +7,7 @@
 # The directory Mix downloads your dependencies sources to.
 /deps/
 
-# Where 3rd-party dependencies like ExDoc output generated docs.
+# Where third-party dependencies like ExDoc output generated docs.
 /doc/
 
 # Ignore .fetch files in case you like to edit your project deps locally.
@@ -22,6 +22,10 @@ erl_crash.dump
 # Ignore package tarball (built via "mix hex.build").
 extrace-*.tar
 
+# Temporary files, for example, from tests.
+/tmp/
+
+# Misc.
 .elixir_ls
 .idea
 *.iml

LICENSE

@@ -174,28 +174,3 @@ incurred by, or claims asserted against, such Contributor by reason
 of your accepting any such warranty or additional liability.
 
 END OF TERMS AND CONDITIONS
-
-APPENDIX: How to apply the Apache License to your work.
-
-To apply the Apache License to your work, attach the following
-boilerplate notice, with the fields enclosed by brackets "{}"
-replaced with your own identifying information. (Don't include
-the brackets!)  The text should be enclosed in the appropriate
-comment syntax for the file format. We also recommend that a
-file or class name and description of purpose be included on the
-same "printed page" as the copyright notice for easier
-identification within third-party archives.
-
-Copyright 2016 Bing Han
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.

Original-LICENSE ORIGINAL-LICENSE.md

@@ -1,21 +1,38 @@
 # Extrace
 
 [![Hex.pm Version](https://img.shields.io/hexpm/v/extrace.svg?style=flat-square)](https://hex.pm/packages/extrace)
+[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg?style=flat-square)](https://hexdocs.pm/extrace/)
+[![Total Download](https://img.shields.io/hexpm/dt/extrace.svg?style=flat-square)](https://hex.pm/packages/extrace)
+[![License](https://img.shields.io/hexpm/l/extrace.svg?style=flat-square)](https://github.com/redink/extrace/blob/master/LICENSE.md)
+[![Last Updated](https://img.shields.io/github/last-commit/redink/extrace.svg?style=flat-square)](https://github.com/redink/extrace/commits/master)
 
 Extrace is an Elixir wrapper for [Recon Trace](https://ferd.github.io/recon/recon_trace.html).
 
-## Example
+## Installation
 
-1, set point
+The package can be installed by adding `:extrace` to your list of dependencies
+in `mix.exs`:
 
 ```elixir
-iex(1)> Extrace.calls([{Enum, :take_random, fn _ -> :return end}, {Enum, :count, fn _ -> :return end}], 100, [scope: :local])
+def deps do
+  [
+    {:extrace, "~> 0.3.0"}
+  ]
+end
+```
+
+## Examples
+
+Set point:
+
+```elixir
+iex> Extrace.calls([{Enum, :take_random, fn _ -> :return end}, {Enum, :count, fn _ -> :return end}], 100, [scope: :local])
 4
 ```
 
 Note that the functions to be traced (`:take_random` and `:count` in the example above) can only be private if `scope: :local` is set.
 
-2, one function executed
+One function executed:
 
 ```elixir
 iex(2)> Enum.take_random([1,2,3,4], 200)
@@ -46,7 +63,7 @@ iex(2)> Enum.take_random([1,2,3,4], 200)
 18:42:10.842046 <0.183.0> Enum.take_random/2 --> [2, 4, 3, 1]
 ```
 
-3, another function executed
+Another function executed:
 
 ```elixir
 iex(4)> Enum.count([1,2,3,4])
@@ -57,5 +74,20 @@ iex(4)> Enum.count([1,2,3,4])
 18:42:27.383795 <0.183.0> Enum.count/1 --> 4
 ```
 
-## Other
-Original library [repository](https://github.com/tatsuya6502/recon_ex)
+## Copyright and License
+
+Copyright (c) 2015, 2016 Tatsuya Kawano under [MIT License](./ORIGINAL-LICENSE.md). Fork from [https://github.com/tatsuya6502/recon_ex](https://github.com/tatsuya6502/recon_ex)
+
+Copyright (c) 2019 redink
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

README.md

@@ -5,13 +5,15 @@ defmodule Extrace do
   @moduledoc """
   `Extrace` provides functions for tracing events in a safe
   manner for single Erlang virtual machine, currently for function
-  calls only. Functionality includes:
+  calls only.
+
+  Functionality includes:
 
   - Nicer to use interface (arguably) than `:dbg` or trace BIFs.
   - Protection against dumb decisions (matching all calls on a node
     being traced, for example)
   - Adding safe guards in terms of absolute trace count or
-    rate-limitting
+    rate-limiting
   - Nicer formatting than default traces
 
   ## Tracing Elixir and Erlang Code
@@ -106,13 +108,13 @@ defmodule Extrace do
   an integer greater than `1`.
 
   The limit was also set using `{10, 100}` instead of an integer,
-  making the rate-limitting at 10 messages per 100 milliseconds,
+  making the rate-limiting at 10 messages per 100 milliseconds,
   instead of an absolute value.
 
   Any tracing can be manually interrupted by calling
   `Extrace.clear/0`, or killing the shell process.
 
-  Be aware that extremely broad patterns with lax rate-limitting (or
+  Be aware that extremely broad patterns with lax rate-limiting (or
   very high absolute limits) may impact your node's stability in ways
   `Extrace` cannot easily help you with.
 
@@ -328,7 +330,7 @@ defmodule Extrace do
 
   @doc """
   Returns tspec with its `shellfun` replaced with `matchspec`.
-  This futction is used by `calls/2` and `calls/3`.
+  This function is used by `calls/2` and `calls/3`.
   """
   @spec to_erl_tspec(tspec) :: tspec
   def to_erl_tspec({mod, fun, shellfun}) when is_function(shellfun) do

lib/extrace.ex

@@ -1,20 +1,18 @@
 defmodule Extrace.MixProject do
   use Mix.Project
 
+  @source_url "https://github.com/redink/extrace"
+  @version "0.3.0"
+
   def project do
     [
       app: :extrace,
-      version: "0.3.0",
+      version: @version,
       elixir: "~> 1.7",
       start_permanent: Mix.env() == :prod,
+      package: package(),
       deps: deps(),
-      description: "Elixir wrapper for Recon Trace.",
-      package: [
-        name: "extrace",
-        maintainers: ["redink"],
-        licenses: ["Apache 2.0"],
-        links: %{"GitHub" => "https://github.com/redink/extrace"}
-      ]
+      docs: docs()
     ]
   end
 
@@ -27,7 +25,32 @@ defmodule Extrace.MixProject do
   defp deps do
     [
       {:recon, "~> 2.5"},
-      {:ex_doc, "~> 0.19", only: [:dev, :test]}
+      {:ex_doc, ">= 0.0.0", only: [:dev, :test], runtime: false}
+    ]
+  end
+
+  defp package do
+    [
+      name: "extrace",
+      description: "Elixir wrapper for Recon Trace.",
+      maintainers: ["redink"],
+      licenses: ["Apache-2.0"],
+      links: %{
+        "GitHub" => @source_url
+      }
+    ]
+  end
+
+  defp docs do
+    [
+      extras: [
+        "ORIGINAL-LICENSE.md": [title: "Original License"],
+        LICENSE: [title: "License"],
+        "README.md": [title: "Overview"]
+      ],
+      main: "readme",
+      source_url: @source_url,
+      formatters: ["html"]
     ]
   end
 end