From 9d055a779ff1e1c6dcc09da7be2bd473216f0786 Mon Sep 17 00:00:00 2001 From: Daniel Neighman Date: Mon, 28 Dec 2015 12:14:27 -0800 Subject: [PATCH] Updates some docs configuration to fix the docs on hex --- README.md | 1 - mix.exs | 12 +++++++++++- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4c76f937f..cca1700b6 100644 --- a/README.md +++ b/README.md @@ -493,7 +493,6 @@ feedback to get up and running. - [x] Integration with Plug - [x] Basic integrations like raw TCP - [x] Sevice2Service credentials. That is, pass the authentication results through many downstream requests. -- [ ] Create a "csrf" token type that ensures that CSRF protection is included - [x] Integration with Phoenix channels - [x] Integrated permission sets - [x] Hooks into the authentication cycle diff --git a/mix.exs b/mix.exs index bd2f9dfd5..0061b21aa 100644 --- a/mix.exs +++ b/mix.exs @@ -7,16 +7,18 @@ defmodule Guardian.Mixfile do def project do [ + name: "Guardian", app: :guardian, version: @version, elixir: "~> 1.1", package: package, + source_url: @url, build_embedded: Mix.env == :prod, start_permanent: Mix.env == :prod, maintainers: @maintainers, description: "Elixir Authentication framework", homepage_url: @url, - docs: [source_ref: "v#{@version}", main: "overview"], + docs: docs, deps: deps ] end @@ -25,6 +27,14 @@ defmodule Guardian.Mixfile do [applications: [:logger, :poison, :jose, :uuid]] end + def docs do + [ + extras: ["README.md", "CHANGELOG.md"], + source_ref: "v#{@version}", + main: "extra-readme" + ] + end + defp deps do [{:jose, "~> 1.4"}, {:poison, "~> 1.5"},