Update README
This commit is contained in:
parent
2e7682c503
commit
c3831c5c2b
20
README.md
20
README.md
|
|
@ -1,21 +1,7 @@
|
||||||
# ZombieSurvivor
|
# ZombieSurvivor
|
||||||
|
|
||||||
**TODO: Add description**
|
A Zombie survivor kata, as seen [in the kata catalog](https://github.com/ardalis/kata-catalog/blob/master/katas/Zombie%20Survivors.md).
|
||||||
|
|
||||||
## Installation
|
## Documentation
|
||||||
|
|
||||||
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
|
|
||||||
by adding `zombie_survivor` to your list of dependencies in `mix.exs`:
|
|
||||||
|
|
||||||
```elixir
|
|
||||||
def deps do
|
|
||||||
[
|
|
||||||
{:zombie_survivor, "~> 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/zombie_survivor](https://hexdocs.pm/zombie_survivor).
|
|
||||||
|
|
||||||
|
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc).
|
||||||
Loading…
Reference in New Issue