Merge pull request #4 from kianmeng/misc-doc-changes

Misc doc changes

Author: artemeff

README.md

@@ -1,4 +1,4 @@
-# Sparrow [![Build Status](https://img.shields.io/travis/ExpressApp/sparrow.svg)](https://travis-ci.org/ExpressApp/sparrow) [![Hex.pm](https://img.shields.io/hexpm/v/sparrow.svg)](https://hex.pm/packages/sparrow)
+# Sparrow [![Build Status](https://img.shields.io/travis/ExpressApp/sparrow.svg)](https://travis-ci.org/ExpressApp/sparrow) [![Hex.pm](https://img.shields.io/hexpm/v/sparrow.svg)](https://hex.pm/packages/sparrow) [![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/sparrow/) [![Total Download](https://img.shields.io/hexpm/dt/sparrow.svg)](https://hex.pm/packages/sparrow) [![License](https://img.shields.io/hexpm/l/sparrow.svg)](https://hex.pm/packages/sparrow) [![Last Updated](https://img.shields.io/github/last-commit/ExpressApp/sparrow.svg)](https://github.com/ExpressApp/sparrow/commits/master)
 
 ---
 
@@ -22,31 +22,31 @@ Sentry client for Elixir based on the new Erlang's [logger](http://erlang.org/do
 
 ## Installation
 
-1. Add `sparrrow` to your list of dependencies in `mix.exs`:
-
-```elixir
-def deps do
-  [
-    {:sparrow, "~> 1.0"}
-  ]
-end
-```
-
-2. Add configuration to your app:
-
-```elixir
-# config/config.exs
-
-config :sparrow,
-  dsn: "your_sentry_dsn",
-  # optional configuration
-  server_name: "server_name",
-  release: "1.14.3-rc.3",
-  tags: %{
-    some: "of",
-    your: "tags",
-  }
-```
+1.  Add `sparrrow` to your list of dependencies in `mix.exs`:
+
+    ```elixir
+    def deps do
+      [
+        {:sparrow, "~> 1.0"}
+      ]
+    end
+    ```
+
+2.  Add configuration to your app:
+
+    ```elixir
+    # config/config.exs
+
+    config :sparrow,
+      dsn: "your_sentry_dsn",
+      # optional configuration
+      server_name: "server_name",
+      release: "1.14.3-rc.3",
+      tags: %{
+        some: "of",
+        your: "tags",
+      }
+    ```
 
 ---
 

mix.exs

@@ -1,18 +1,22 @@
 defmodule Sparrow.MixProject do
   use Mix.Project
 
+  @source_url "https://github.com/ExpressApp/sparrow"
+  @version "1.1.1"
+
   def project do
     [
       app: :sparrow,
-      version: "1.1.1",
+      version: @version,
       elixir: "~> 1.9",
-      elixirc_paths: elixirc_paths(Mix.env),
+      elixirc_paths: elixirc_paths(Mix.env()),
       start_permanent: Mix.env() == :prod,
       deps: deps(),
 
       # Hex
       description: description(),
       package: package(),
+      docs: docs()
     ]
   end
 
@@ -24,13 +28,12 @@ defmodule Sparrow.MixProject do
   end
 
   defp elixirc_paths(:test), do: ["lib", "test/support"]
-  defp elixirc_paths(_),     do: ["lib"]
+  defp elixirc_paths(_), do: ["lib"]
 
   defp deps do
     [
       {:hackney, ">= 1.8.0"},
       {:jason, ">= 0.0.0", optional: true},
-
       {:mox, "~> 0.5", only: :test},
       {:plug, "~> 1.7", only: :test},
       {:plug_cowboy, "~> 2.0", only: :test},
@@ -47,7 +50,19 @@ defmodule Sparrow.MixProject do
       name: :sparrow,
       maintainers: ["Yuri Artemev"],
       licenses: ["MIT"],
-      links: %{"GitHub" => "https://github.com/ExpressApp/sparrow"}
+      links: %{
+        "Changelog" => "#{@source_url}/blob/master/CHANGELOG.md",
+        "GitHub" => @source_url
+      }
+    ]
+  end
+
+  defp docs do
+    [
+      main: "readme",
+      source_ref: "v#{@version}",
+      source_url: @source_url,
+      extras: ["README.md", "CHANGELOG.md"]
     ]
   end
 end