diff --git a/.travis.yml b/.travis.yml index 53a38ed..6d8baf5 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,3 +1,15 @@ language: elixir elixir: - - '1.5' + - 1.5.0 +notifications: + recipients: + - theavitex@gmail.com +otp_release: + - 18.2 +env: + - MIX_ENV=test +script: + - mix do deps.get, compile +after_script: + - mix deps.get --only docs + - MIX_ENV=docs mix inch.report diff --git a/README.md b/README.md index 42c2708..c331c8c 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,18 @@ -# elixir-glicko (IN-PROGRESS) -An Elixir implementation of the Glicko rating system. +[![Build Status](https://travis-ci.org/avitex/elixir-glicko.svg)](https://travis-ci.org/avitex/elixir-glicko) +[![Hex.pm](https://img.shields.io/hexpm/v/glicko.svg)](https://hex.pm/packages/glicko) +[![Hex Docs](https://img.shields.io/badge/hex-docs-blue.svg)](https://hexdocs.pm/glicko) + +# Glicko (IN-PROGRESS) + +**Implementation of the [Glicko rating system](http://www.glicko.net/glicko.html).** +Documentation hosted on [hexdocs](https://hexdocs.pm/glicko). + +## Installation + + Add `glicko` to your list of dependencies in `mix.exs`: + + ```elixir + def deps do + [{:glicko, "~> 0.1.0"}] + end + ``` diff --git a/mix.exs b/mix.exs index 4185f6a..49d398f 100644 --- a/mix.exs +++ b/mix.exs @@ -1,20 +1,30 @@ defmodule Glicko.Mixfile do use Mix.Project + @description """ + Implementation of the Glicko rating system + """ + def project, do: [ app: :glicko, version: "0.1.0", elixir: "~> 1.5", start_permanent: Mix.env == :prod, deps: deps(), - ] - - def application, do: [ - extra_applications: [:logger], + package: package(), + description: @description, ] defp deps, do: [ + {:inch_ex, "~> 0.5", only: :docs}, {:ex_doc, "~> 0.16", only: :dev, runtime: false}, {:credo, "~> 0.8", only: [:dev, :test], runtime: false}, ] + + defp package, do: [ + name: :glicko, + maintainers: ["James Dyson"], + licenses: ["MIT"], + links: %{"GitHub" => "https://github.com/avitex/elixir-glicko"}, + ] end diff --git a/mix.lock b/mix.lock index e9a7da8..abbe55f 100644 --- a/mix.lock +++ b/mix.lock @@ -1,4 +1,6 @@ %{"bunt": {:hex, :bunt, "0.2.0", "951c6e801e8b1d2cbe58ebbd3e616a869061ddadcc4863d0a2182541acae9a38", [:mix], []}, "credo": {:hex, :credo, "0.8.8", "990e7844a8d06ebacd88744a55853a83b74270b8a8461c55a4d0334b8e1736c9", [:mix], [{:bunt, "~> 0.2.0", [hex: :bunt, optional: false]}]}, "earmark": {:hex, :earmark, "1.2.3", "206eb2e2ac1a794aa5256f3982de7a76bf4579ff91cb28d0e17ea2c9491e46a4", [:mix], []}, - "ex_doc": {:hex, :ex_doc, "0.18.1", "37c69d2ef62f24928c1f4fdc7c724ea04aecfdf500c4329185f8e3649c915baf", [:mix], [{:earmark, "~> 1.1", [hex: :earmark, optional: false]}]}} + "ex_doc": {:hex, :ex_doc, "0.18.1", "37c69d2ef62f24928c1f4fdc7c724ea04aecfdf500c4329185f8e3649c915baf", [:mix], [{:earmark, "~> 1.1", [hex: :earmark, optional: false]}]}, + "inch_ex": {:hex, :inch_ex, "0.5.6", "418357418a553baa6d04eccd1b44171936817db61f4c0840112b420b8e378e67", [:mix], [{:poison, "~> 1.5 or ~> 2.0 or ~> 3.0", [hex: :poison, optional: false]}]}, + "poison": {:hex, :poison, "3.1.0", "d9eb636610e096f86f25d9a46f35a9facac35609a7591b3be3326e99a0484665", [:mix], []}}