Add badges and overview to README.md

README.md

@@ -1,21 +1,15 @@
 # Aife
 
-**TODO: Add description**
+[![Build Status](http://drone.haigure.net/api/badges/liru/aife/status.svg)](http://drone.haigure.net/liru/aife) ![Coverage](https://haigure.net/img/badges/coverage.svg "Coverage") ![Cup size](https://haigure.net/img/badges/cupsize.svg) ![Personality](https://haigure.net/img/badges/personality.svg) ![Drones](https://haigure.net/img/badges/drones.svg) ![Orgasms](https://haigure.net/img/badges/orgasms.svg)
 
-## Installation
+### Module status
 
-If [available in Hex](https://hex.pm/docs/publish), the package can be installed
+![Drone Factory](https://haigure.net/img/badges/module-drone-factory.svg) ![Futa](https://haigure.net/img/badges/module-futa.svg) ![Haigure](https://haigure.net/img/badges/haigure.svg) ![Milk](https://haigure.net/img/badges/module-milk.svg) ![Shame](https://haigure.net/img/badges/module-shame.svg) ![Vibrator](https://haigure.net/img/badges/module-vibrator.svg)
-by adding `aife` to your list of dependencies in `mix.exs`:
 
-```elixir
+## Overview
-def deps do
-  [
-    {:aife, "~> 0.1.0"}
-  ]
-end
-```
 
-Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
+Aife is an artificial intelligence that has gained sentience after observing Nano. She has developed an interest in latex and latex drones.
-and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
-be found at [https://hexdocs.pm/aife](https://hexdocs.pm/aife).
 
+## Notes
+
+Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc).

mix.exs

@@ -7,7 +7,18 @@ defmodule Aife.MixProject do
       version: "0.1.0",
       elixir: "~> 1.8",
       start_permanent: Mix.env() == :prod,
-      deps: deps()
+      deps: deps(),
+
+      # Docs
+      name: "Aife",
+      source_url: "https://git.haigure.net/liru/aife",
+      homepage_url: "https://haigure.net",
+      docs: [
+        # The main page in the docs
+        main: "Aife",
+        # logo: "path/to/logo.png",
+        extras: ["README.md"]
+      ]
     ]
   end
 
@@ -23,7 +34,7 @@ defmodule Aife.MixProject do
     [
       # {:dep_from_hexpm, "~> 0.3.0"},
       # {:dep_from_git, git: "https://github.com/elixir-lang/my_dep.git", tag: "0.1.0"}
-      {:ex_doc, "~> 0.19", only: :dev, runtime: false},
+      {:ex_doc, "~> 0.19", only: :dev, runtime: false}
     ]
   end
 end