chore: update readme re hex publication.
All checks were successful
continuous-integration/drone/push Build is passing

This commit is contained in:
James Harton 2023-09-09 19:49:24 +12:00
parent cbe223ec03
commit cf5565e2a4
Signed by: james
GPG key ID: 90E82DAA13F624F4
2 changed files with 8 additions and 7 deletions

View file

@ -32,20 +32,18 @@ end
## Installation
Smokestack is not yet ready to be published to [Hex](https://hex.pm) so in the
mean time if you want to try it you need to add a git-based dependency:
Smokestack is available on [Hex](https://hex.pm/packages/smokestack) you can
add it directly to your `mix.exs`:
```elixir
def deps do
[
{:smokestack, git: "https://code.harton.nz/cinder/cinder", tag: "v0.1.0"}
{:smokestack, "~> 0.3"},
]
end
```
Since the package hasn't been published, there are no docs available on
[HexDocs](https://hexdocs.pm/), but you can access the latest version
[here](https://docs.harton.nz/james/smokestack).
Documentation for the latest release is available on [HexDocs](http://hexdocs.pm/smokestack).
## Github Mirror

View file

@ -21,7 +21,10 @@ defmodule Smokestack.MixProject do
source_url: "https://code.harton.nz/james/smokestack",
homepage_url: "https://code.harton.nz/james/smokestack",
aliases: aliases(),
dialyzer: [plt_add_apps: [:faker]]
dialyzer: [plt_add_apps: [:faker]],
docs: [
main: "Smokestack"
]
]
end