chore: Update package and readme links.
All checks were successful
continuous-integration/drone/push Build is passing

This commit is contained in:
James Harton 2024-03-06 20:02:54 +13:00
parent b9320737af
commit 1718cee34a
Signed by: james
GPG key ID: 90E82DAA13F624F4
2 changed files with 29 additions and 11 deletions

View file

@ -1,34 +1,44 @@
# Vivid.PNG
[![Build Status](https://drone.harton.nz/api/badges/james/vivid_png/status.svg?ref=refs/heads/main)](https://drone.harton.nz/james/vivid_png)
[![Build Status](https://drone.harton.dev/api/badges/james/vivid_png/status.svg?ref=refs/heads/main)](https://drone.harton.dev/james/vivid_png)
[![Hex.pm](https://img.shields.io/hexpm/v/vivid_png.svg)](https://hex.pm/packages/vivid_png)
`Vivid.PNG` adds PNG generating support to [Vivid](https://hex.pm/packages/vivid),
a 2D rendering library implemented 100% in Elixir with no dependencies.
## Accessing on GitHub
This repository is [mirrored to GitHub](https://github.com/jimsynz/vivid_png.ex) from it's home on [harton.dev](https://harton.dev/james/vivid_png). Feel free to raise issues, etc, on GitHub.
This repository is [mirrored to GitHub](https://github.com/jimsynz/vivid_png.ex) from it's home on [harton.dev](https://harton.dev/james/vivid_png). Feel free to raise issues, etc, on GitHub.
## Installation
[Available in Hex](https://hex.pm/packages/vivid_png), the package can be installed
by adding `vivid_png` to your list of dependencies in `mix.exs`:
`Vivid.PNG` is [available in Hex](https://hex.pm/packages/vivid_png), the
package can be installed by adding `vivid_png` to your list of dependencies in
`mix.exs`:
```elixir
def deps do
[{:vivid_png, "~> 0.2.0"}]
[
{:vivid_png, "~> 0.2.0"}
]
end
```
Documentation for the latest release can be found on
[HexDocs](https://hexdocs.pm/vivid_png) and for the `main` branch on
[docs.harton.nz](https://docs.harton.nz/james/vivid_png).
## Github Mirror
This repository is mirrored [on Github](https://github.com/jimsynz/vivid_png)
from it's primary location [on my Forejo instance](https://harton.dev/james/vivid_png).
Feel free to raise issues and open PRs on Github.
## License
Source code is licensed under the terms of the MIT license, the text of which
is included in the `LICENSE` file in this distribution.
## Documentation
Documentations can be found at [https://hexdocs.pm/vivid_png](https://hexdocs.pm/vivid_png).
## Status
```elixir

12
mix.exs
View file

@ -13,7 +13,12 @@ defmodule Vivid.PNG.Mixfile do
build_embedded: Mix.env() == :prod,
start_permanent: Mix.env() == :prod,
package: package(),
deps: deps()
deps: deps(),
source_url: "https://harton.dev/james/vivid_png",
homepage_url: "https://harton.dev/james/vivid_png",
docs: [
extras: ["README.md", "CHANGELOG.md"]
]
]
end
@ -32,7 +37,10 @@ defmodule Vivid.PNG.Mixfile do
maintainers: ["James Harton <james@harton.nz>"],
licenses: ["MIT"],
links: %{
"Source" => "https://harton.dev/james/vivid_png"
"Source" => "https://harton.dev/james/vivid_png",
"GitHub" => "https://github.com/jimsynz/vivid_png",
"Changelog" => "https://docs.harton.nz/james/vivid_png/changelog.html",
"Sponsor" => "https://github.com/sponsors/jimsynz"
}
]
end