diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..6750126 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# Hope + +**TODO: Add description** + +## Installation + +If [available in Hex](https://hex.pm/docs/publish), the package can be installed +by adding `hope` to your list of dependencies in `mix.exs`: + +```elixir +def deps do + [ + {:hope, "~> 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/hope](https://hexdocs.pm/hope). + |