Minimal README
This commit is contained in:
parent
f7cf0fa968
commit
410c409f71
1 changed files with 8 additions and 16 deletions
24
README.md
24
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
|
You'll need the [elixir](https://elixir-lang.org/) toolchain available.
|
||||||
by adding `ha_handler` to your list of dependencies in `mix.exs`:
|
|
||||||
|
|
||||||
```elixir
|
|
||||||
def deps do
|
|
||||||
[
|
|
||||||
{:ha_handler, "~> 0.1.0"}
|
|
||||||
]
|
|
||||||
end
|
|
||||||
```
|
```
|
||||||
|
cd ha-handler/
|
||||||
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
|
mix deps.get
|
||||||
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
|
iex -S mix
|
||||||
be found at [https://hexdocs.pm/ha_handler](https://hexdocs.pm/ha_handler).
|
```
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue