30 lines
612 B
Markdown
30 lines
612 B
Markdown
# Elixir Project
|
|
|
|
A little template for Elixir projects.
|
|
|
|
## Testing
|
|
|
|
This project uses [`mix test`](https://hexdocs.pm/mix/Mix.Tasks.Test.html) to run the tests:
|
|
|
|
```sh
|
|
mix test
|
|
```
|
|
|
|
## Installation
|
|
|
|
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
|
|
by adding `exproj` to your list of dependencies in `mix.exs`:
|
|
|
|
```elixir
|
|
def deps do
|
|
[
|
|
{:exproj, "~> 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/exproj>.
|
|
|