Provide a minimum amount of readme.
This commit is contained in:
parent
4549a4584a
commit
a625f0feb0
2 changed files with 7 additions and 4 deletions
|
@ -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
|
||||
|
|
2
mix.exs
2
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
|
||||
|
|
Reference in a new issue