Current section

Files

Jump to
gen_template_code_quality template $PROJECT_NAME$ README.md
Raw

template/$PROJECT_NAME$/README.md

# <%= @project_name_camel_case %>
**TODO: Add description**
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `<%= @project_name_camel_case %>` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:<%= @project_name %>, "~> 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/template](https://hexdocs.pm/template).