From a625f0feb05c50ab55f06bc0c7b6ec3a022265ea Mon Sep 17 00:00:00 2001
From: James Harton <james@automat.nz>
Date: Sun, 20 Oct 2019 12:03:52 +0200
Subject: [PATCH] Provide a minimum amount of readme.

---
 README.md | 9 ++++++---
 mix.exs   | 2 +-
 2 files changed, 7 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index ae61a2a..a1b39b0 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,14 @@
 # BalenaDevice
 
-**TODO: Add description**
+This package provides an API client for the on-device supervisor provided by the
+Balena IoT platform.  With it you can do things like restart containers, change
+the device hostname and other great stuff.
 
 ## Installation
 
-If [available in Hex](https://hex.pm/docs/publish), the package can be installed
-by adding `balena_device` to your list of dependencies in `mix.exs`:
+This package is [available in Hex](https://hex.pm/packages/balena_device), the
+package can be installed by adding `balena_device` to your list of dependencies
+in `mix.exs`:
 
 ```elixir
 def deps do
diff --git a/mix.exs b/mix.exs
index 5a8bf09..cfee335 100644
--- a/mix.exs
+++ b/mix.exs
@@ -18,7 +18,7 @@ defmodule BalenaDevice.MixProject do
       maintainers: ["James Harton <jamesh@balena.io>"],
       licenses: ["MIT"],
       links: %{
-        "Source" => "https://gitlab.com/jimsy/balena_device"
+        "Source" => "https://gitlab.com/jimsy/balena-device"
       }
     ]
   end