liru
/
elixir_zombie_survivor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update README

This commit is contained in:
Liru 2018-04-20 22:11:41 -04:00
parent 2e7682c503
commit c3831c5c2b
1 changed files with 3 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -1,21 +1,7 @@
# 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
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
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc).