Docs improvements

README.md

@@ -2,7 +2,12 @@
 
 [![Build Status](https://github.com/fredwu/opq/actions/workflows/ci.yml/badge.svg)](https://github.com/fredwu/opq/actions)
 [![CodeBeat](https://codebeat.co/badges/76916047-5b66-466d-91d3-7131a269899a)](https://codebeat.co/projects/github-com-fredwu-opq-master)
-[![Coverage](https://img.shields.io/coveralls/fredwu/opq.svg)](https://coveralls.io/github/fredwu/opq?branch=master) [![Hex.pm](https://img.shields.io/hexpm/v/opq.svg)](https://hex.pm/packages/opq)
+[![Coverage](https://img.shields.io/coveralls/fredwu/opq.svg)](https://coveralls.io/github/fredwu/opq?branch=master)
+[![Hex Version](https://img.shields.io/hexpm/v/opq.svg)](https://hex.pm/packages/opq)
+[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/opq/)
+[![Total Download](https://img.shields.io/hexpm/dt/opq.svg)](https://hex.pm/packages/opq)
+[![License](https://img.shields.io/hexpm/l/opq.svg)](https://github.com/fredwu/opq/blob/master/LICENSE.md)
+[![Last Updated](https://img.shields.io/github/last-commit/fredwu/opq.svg)](https://github.com/fredwu/crawler/commits/master)
 
 ## Elixir Queue!
 
@@ -18,6 +23,8 @@ Originally built to support [Crawler](https://github.com/fredwu/crawler).
 - Timeouts.
 - Pause / resume / stop the queue.
 
+See [Hex documentation](https://hexdocs.pm/opq/).
+
 ## Installation
 
 ```Elixir

mix.exs

@@ -1,17 +1,21 @@
 defmodule OPQ.Mixfile do
   use Mix.Project
 
+  @source_url "https://github.com/fredwu/crawler"
+  @version "3.3.0"
+
   def project do
     [
       app: :opq,
-      version: "3.3.0",
+      version: @version,
       elixir: "~> 1.5",
       elixirc_paths: elixirc_paths(Mix.env()),
       package: package(),
       name: "OPQ: One Pooled Queue",
       description: "A simple, in-memory queue with worker pooling and rate limiting in Elixir.",
       start_permanent: Mix.env() == :prod,
       deps: deps(),
+      docs: docs(),
       test_coverage: [tool: ExCoveralls],
       preferred_cli_env: [coveralls: :test],
       aliases: [publish: ["hex.publish", &git_tag/1]]
@@ -39,7 +43,7 @@ defmodule OPQ.Mixfile do
     [
       maintainers: ["Fred Wu"],
       licenses: ["MIT"],
-      links: %{"GitHub" => "https://github.com/fredwu/opq"}
+      links: %{"GitHub" => @source_url}
     ]
   end
 
@@ -48,4 +52,14 @@ defmodule OPQ.Mixfile do
     System.cmd("git", ["push"])
     System.cmd("git", ["push", "--tags"])
   end
+
+  defp docs do
+    [
+      extras: ["CHANGELOG.md": [title: "Changelog"], "README.md": [title: "Overview"]],
+      main: "readme",
+      source_url: @source_url,
+      source_ref: "v#{@version}",
+      formatters: ["html"]
+    ]
+  end
 end