README.md
# Sims
WIP - This repo contains examples of test simulators that can be used to test
external services.
My goal is for this to eventually be a code generator that lays down the
boilerplate for simulating external services.
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `sims` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:sims, "~> 0.1.0", only: [:dev]}
]
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/sims>.