chore: update readme re hex publication.
All checks were successful
continuous-integration/drone/push Build is passing
All checks were successful
continuous-integration/drone/push Build is passing
This commit is contained in:
parent
cbe223ec03
commit
cf5565e2a4
2 changed files with 8 additions and 7 deletions
10
README.md
10
README.md
|
@ -32,20 +32,18 @@ end
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
Smokestack is not yet ready to be published to [Hex](https://hex.pm) so in the
|
Smokestack is available on [Hex](https://hex.pm/packages/smokestack) you can
|
||||||
mean time if you want to try it you need to add a git-based dependency:
|
add it directly to your `mix.exs`:
|
||||||
|
|
||||||
```elixir
|
```elixir
|
||||||
def deps do
|
def deps do
|
||||||
[
|
[
|
||||||
{:smokestack, git: "https://code.harton.nz/cinder/cinder", tag: "v0.1.0"}
|
{:smokestack, "~> 0.3"},
|
||||||
]
|
]
|
||||||
end
|
end
|
||||||
```
|
```
|
||||||
|
|
||||||
Since the package hasn't been published, there are no docs available on
|
Documentation for the latest release is available on [HexDocs](http://hexdocs.pm/smokestack).
|
||||||
[HexDocs](https://hexdocs.pm/), but you can access the latest version
|
|
||||||
[here](https://docs.harton.nz/james/smokestack).
|
|
||||||
|
|
||||||
## Github Mirror
|
## Github Mirror
|
||||||
|
|
||||||
|
|
5
mix.exs
5
mix.exs
|
@ -21,7 +21,10 @@ defmodule Smokestack.MixProject do
|
||||||
source_url: "https://code.harton.nz/james/smokestack",
|
source_url: "https://code.harton.nz/james/smokestack",
|
||||||
homepage_url: "https://code.harton.nz/james/smokestack",
|
homepage_url: "https://code.harton.nz/james/smokestack",
|
||||||
aliases: aliases(),
|
aliases: aliases(),
|
||||||
dialyzer: [plt_add_apps: [:faker]]
|
dialyzer: [plt_add_apps: [:faker]],
|
||||||
|
docs: [
|
||||||
|
main: "Smokestack"
|
||||||
|
]
|
||||||
]
|
]
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue