Misc doc changes

List of changes:

- Show source reference by tagged version
- Add changelog to html doc
- Sort and group deps
- Align content indentation accordingly under list
- Badges and more badges!
- Add changelog link to hex module info page
- Update license year

LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Fewlines SAS
+Copyright (c) 2016-current Fewlines SAS
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,65 +1,70 @@
-[![Hex pm](https://img.shields.io/hexpm/v/bamboo_smtp.svg)](https://hex.pm/packages/bamboo_smtp)
+# Bamboo.SMTPAdapter
+
 [![Build Status](https://github.com/fewlinesco/bamboo_smtp/workflows/Bamboo%20SMTP/badge.svg)](https://github.com/fewlinesco/bamboo_smtp/actions)
 [![Inline docs](http://inch-ci.org/github/fewlinesco/bamboo_smtp.svg)](http://inch-ci.org/github/fewlinesco/bamboo_smtp)
+[![Module Version](https://img.shields.io/hexpm/v/bamboo_smtp.svg)](https://hex.pm/packages/bamboo_smtp)
+[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/bamboo_smtp/)
+[![Total Download](https://img.shields.io/hexpm/dt/bamboo_smtp.svg)](https://hex.pm/packages/bamboo_smtp)
+[![License](https://img.shields.io/hexpm/l/bamboo_smtp.svg)](https://github.com/fewlinesco/bamboo_smtp/blob/master/LICENSE)
+[![Last Updated](https://img.shields.io/github/last-commit/fewlinesco/bamboo_smtp.svg)](https://github.com/fewlinesco/bamboo_smtp/commits/master)
 
-# Bamboo.SMTPAdapter
-
-An Adapter for the [Bamboo](https://github.com/thoughtbot/bamboo) email app.
+An adapter for the [Bamboo](https://github.com/thoughtbot/bamboo) email app.
 
 ## Installation
 
 The package can be installed as:
 
 1. Add `bamboo_smtp` to your list of dependencies in `mix.exs`:
 
-  ```elixir
-  def deps do
-    [{:bamboo_smtp, "~> 3.1.0"}]
-  end
-  ```
+   ```elixir
+   def deps do
+     [{:bamboo_smtp, "~> 3.1.0"}]
+   end
+   ```
 
-2. Add `bamboo` and `bamboo_smtp` to your list of applications in `mix.exs`:
+2. Add `:bamboo` and `:bamboo_smtp` to your list of applications in `mix.exs`:
 
-  ```elixir
-  def application do
-    [applications: [:bamboo, :bamboo_smtp]]
-  end
-  ```
+   ```elixir
+   def application do
+     [applications: [:bamboo, :bamboo_smtp]]
+   end
+   ```
 
 3. Setup your SMTP configuration:
 
-  ```elixir
-  # In your config/config.exs file
-  config :my_app, MyApp.Mailer,
-    adapter: Bamboo.SMTPAdapter,
-    server: "smtp.domain",
-    hostname: "your.domain",
-    port: 1025,
-    username: "[email protected]", # or {:system, "SMTP_USERNAME"}
-    password: "pa55word", # or {:system, "SMTP_PASSWORD"}
-    tls: :if_available, # can be `:always` or `:never`
-    allowed_tls_versions: [:"tlsv1", :"tlsv1.1", :"tlsv1.2"], # or {:system, "ALLOWED_TLS_VERSIONS"} w/ comma seprated values (e.g. "tlsv1.1,tlsv1.2")
-    ssl: false, # can be `true`
-    retries: 1,
-    no_mx_lookups: false, # can be `true`
-    auth: :if_available # can be `:always`. If your smtp relay requires authentication set it to `:always`.
-  ```
-
-*Sensitive credentials should not be committed to source control and are best kept in environment variables.
-Using `{:system, "ENV_NAME"}` configuration is read from the named environment variable at runtime.*
-
-The *hostname* option sets the FQDN to the header of your emails, its optional, but if you don't set it, the underlying `gen_smtp` module will use the hostname of your machine, like `localhost`.
+   ```elixir
+   # In your config/config.exs file
+   config :my_app, MyApp.Mailer,
+     adapter: Bamboo.SMTPAdapter,
+     server: "smtp.domain",
+     hostname: "your.domain",
+     port: 1025,
+     username: "[email protected]", # or {:system, "SMTP_USERNAME"}
+     password: "pa55word", # or {:system, "SMTP_PASSWORD"}
+     tls: :if_available, # can be `:always` or `:never`
+     allowed_tls_versions: [:"tlsv1", :"tlsv1.1", :"tlsv1.2"], # or {:system, "ALLOWED_TLS_VERSIONS"} w/ comma seprated values (e.g. "tlsv1.1,tlsv1.2")
+     ssl: false, # can be `true`
+     retries: 1,
+     no_mx_lookups: false, # can be `true`
+     auth: :if_available # can be `:always`. If your smtp relay requires authentication set it to `:always`.
+   ```
+
+   *Sensitive credentials should not be committed to source control and are best kept in environment variables.
+   Using `{:system, "ENV_NAME"}` configuration is read from the named environment variable at runtime.*  
+
+   The *hostname* option sets the FQDN to the header of your emails, its optional, but if you don't set it, the underlying `gen_smtp` module will use the hostname of your machine, like `localhost`.
 
 4. Follow Bamboo [Getting Started Guide](https://github.com/thoughtbot/bamboo#getting-started)
 
 5. **Optional** Set `BambooSMTP.TestAdapter` as your test adapter:
 
-  ```elixir
- # In your config/config.exs file
- if Mix.env() == :test do
-   config :my_app, MyApp.Mailer, adapter: MyApp.SMTPTestAdapter
- end
- ```
+   ```elixir
+   # In your config/config.exs file
+   if Mix.env() == :test do
+     config :my_app, MyApp.Mailer, adapter: MyApp.SMTPTestAdapter
+   end
+   ```
+
 ## Usage
 
 You can find more information about advanced features in the [Wiki](https://github.com/fewlinesco/bamboo_smtp/wiki).

mix.exs

@@ -2,11 +2,12 @@ defmodule BambooSmtp.Mixfile do
   use Mix.Project
 
   @project_url "https://github.com/fewlinesco/bamboo_smtp"
+  @version "3.1.0"
 
   def project do
     [
       app: :bamboo_smtp,
-      version: "3.1.0",
+      version: @version,
       elixir: "~> 1.7",
       source_url: @project_url,
       homepage_url: @project_url,
@@ -17,7 +18,7 @@ defmodule BambooSmtp.Mixfile do
       test_coverage: [tool: ExCoveralls],
       package: package(),
       deps: deps(),
-      docs: [main: "readme", extras: ["README.md"]]
+      docs: docs()
     ]
   end
 
@@ -27,12 +28,17 @@ defmodule BambooSmtp.Mixfile do
 
   defp deps do
     [
+      # core
       {:bamboo, "~> 1.6"},
+      {:gen_smtp, "~> 1.0.1"},
+
+      # dev / test
       {:credo, "~> 1.4.1", only: [:dev, :test]},
-      {:earmark, ">= 1.3.2", only: :docs},
       {:excoveralls, "~> 0.13.3", only: :test},
+
+      # doc
+      {:earmark, ">= 1.3.2", only: :docs},
       {:ex_doc, ex_doc_version(), only: :docs},
-      {:gen_smtp, "~> 1.0.1"},
       {:inch_ex, "~> 2.0.0", only: :docs}
     ]
   end
@@ -49,7 +55,15 @@ defmodule BambooSmtp.Mixfile do
     [
       maintainers: ["Kevin Disneur", "Thomas Gautier"],
       licenses: ["MIT"],
-      links: %{"GitHub" => @project_url}
+      links: %{"Changelog" => "#{@project_url}/blob/master/CHANGELOG.md", "GitHub" => @project_url}
+    ]
+  end
+
+  defp docs do
+    [
+      main: "readme",
+      source_ref: "v#{@version}",
+      extras: ["README.md", "CHANGELOG.md": [title: "Changelog"]]
     ]
   end
 end