docs: Update README and docs generation.
All checks were successful
continuous-integration/drone/push Build is passing

This commit is contained in:
James Harton 2024-02-23 09:56:20 +13:00
parent 744d2d125e
commit ff9cd8a75a
Signed by: james
GPG key ID: 90E82DAA13F624F4
2 changed files with 16 additions and 5 deletions

View file

@ -12,16 +12,20 @@ animations) take a look at [easings.net](http://easings.net)
## Installation
[Available in Hex](https://hex.pm/packages/ease), the package can be installed
Ease is [available in Hex](https://hex.pm/packages/ease), the package can be installed
by adding `ease` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[{:ease, "~> 1.0.0"}]
[
{:ease, "~> 1.0.0"}
]
end
```
Documentation can be found at [https://hexdocs.pm/ease](https://hexdocs.pm/ease).
Documentation for the latest release can be found on
[HexDocs](https://hexdocs.pm/ease) and for the `main` branch on
[docs.harton.nz](https://docs.harton.nz/james/ease).
## Usage

11
mix.exs
View file

@ -12,7 +12,11 @@ defmodule Ease.Mixfile do
build_embedded: Mix.env() == :prod,
start_permanent: Mix.env() == :prod,
package: package(),
deps: deps()
deps: deps(),
docs: [
main: "readme",
extras: ["README.md", "CHANGELOG.md"]
]
]
end
@ -27,7 +31,10 @@ defmodule Ease.Mixfile do
maintainers: ["James Harton <james@harton.nz>"],
licenses: ["HL3-FULL"],
links: %{
"Source" => "https://harton.dev/james/ease"
"Source" => "https://harton.dev/james/ease",
"GitHub" => "https://github.com/jimsynz/ease",
"Changelog" => "https://docs.harton.nz/james/ease/changelog.html",
"Sponsor" => "https://github.com/sponsors/jimsynz"
}
]
end