diff --git a/README.md b/README.md index e05a2e6..e1c971b 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,13 @@ -# HAHandler +# High Availability Handler -**TODO: Add description** +This software monitors and make decision in our High Availability environment. -## Installation +## Development -If [available in Hex](https://hex.pm/docs/publish), the package can be installed -by adding `ha_handler` to your list of dependencies in `mix.exs`: +You'll need the [elixir](https://elixir-lang.org/) toolchain available. -```elixir -def deps do - [ - {:ha_handler, "~> 0.1.0"} - ] -end ``` - -Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc) -and published on [HexDocs](https://hexdocs.pm). Once published, the docs can -be found at [https://hexdocs.pm/ha_handler](https://hexdocs.pm/ha_handler). - +cd ha-handler/ +mix deps.get +iex -S mix +```