james/pca9641
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases 2 Wiki Activity

docs: Update README and package links.

Browse source
This commit is contained in:
James Harton 2024-02-23 20:25:03 +13:00
parent 1661c30de5
commit 0dcd843906
Signed by: james
GPG key ID: 90E82DAA13F624F4
2 changed files with 14 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -13,8 +13,8 @@ mastering devices.
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `pca9641` to your list of dependencies in `mix.exs`:
`pca9641` is [available in Hex](https://hex.pm/packages/pca9641), the package
can be installed by adding `pca9641` to your list of dependencies in `mix.exs`:
```elixir
def deps do
@ -24,9 +24,9 @@ def deps do
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/pca9641](https://hexdocs.pm/pca9641).
Documentation for the latest release can be found on
[HexDocs](https://hexdocs.pm/pca9641) and for the `main` branch on
[docs.harton.nz](https://docs.harton.nz/james/pca9641).
## Github Mirror

11
mix.exs
View file

@ -11,7 +11,11 @@ defmodule PCA9641.MixProject do
start_permanent: Mix.env() == :prod,
description: "Driver for PCA9641 2-channel I2C bus master arbiter chip",
deps: deps(),
package: package()
package: package(),
docs: [
main: "readme",
extras: ["README.md", "CHANGELOG.md"]
]
]
end
@ -27,7 +31,10 @@ defmodule PCA9641.MixProject do
maintainers: ["James Harton <james@harton.nz>"],
licenses: ["HL3-FULL"],
links: %{
"Source" => "https://harton.dev/james/pca9641"
"Source" => "https://harton.dev/james/pca9641",
"GitHub" => "https://github.com/jimsynz/pca9641",
"Changelog" => "https://docs.harton.nz/james/pca9641/changelog.html",
"Sponsor" => "https://github.com/sponsors/jimsynz"
}
]
end