elixir.README.md.mustache Maven / Gradle / Ivy
# {{moduleName}}
{{appDescription}}
## Building
To install the required dependencies and to build the elixir project, run:
```console
mix local.hex --force
mix do deps.get, compile
```
## Installation
If [available in Hex][], the package can be installed by adding `{{#underscored}}{{packageName}}{{/underscored}}` to
your list of dependencies in `mix.exs`:
```elixir
{{=<% %>=}}def deps do
[{<%#atom%><%#underscored%><%packageName%><%/underscored%><%/atom%>, "~> <%appVersion%>"}]
end<%={{ }}=%>
```
Documentation can be generated with [ExDoc][] and published on [HexDocs][]. Once published, the docs can be found at
[https://hexdocs.pm/{{#underscored}}{{packageName}}{{/underscored}}][docs].
## Configuration
You can override the URL of your server (e.g. if you have a separate development and production server in your
configuration files).
```elixir
config :{{#underscored}}{{packageName}}{{/underscored}}, base_url: "{{{basePath}}}"
```
Multiple clients for the same API with different URLs can be created passing different `base_url`s when calling
`{{moduleName}}.Connection.new/1`:
```elixir
client = {{moduleName}}.Connection.new(base_url: "{{{basePath}}}")
```
[exdoc]: https://github.com/elixir-lang/ex_doc
[hexdocs]: https://hexdocs.pm
[available in hex]: https://hex.pm/docs/publish
[docs]: https://hexdocs.pm/{{#underscored}}{{packageName}}{{/underscored}}