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

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

Browse source
This commit is contained in:
James Harton 2024-03-06 19:50:39 +13:00
parent 9b38204bf3
commit 421ded4000
Signed by: james
GPG key ID: 90E82DAA13F624F4
2 changed files with 34 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -1,6 +1,7 @@
# Vivid
[![Build Status](https://drone.harton.nz/api/badges/james/vivid/status.svg?ref=refs/heads/main)](https://drone.harton.nz/james/vivid)
[![Build Status](https://drone.harton.dev/api/badges/james/vivid/status.svg?ref=refs/heads/main)](https://drone.harton.dev/james/vivid)
[![Hex.pm](https://img.shields.io/hexpm/v/vivid.svg)](https://hex.pm/packages/vivid)
Vivid is a simple 2D rendering library.
@ -84,6 +85,29 @@ Frame.push(frame, shape, RGBA.black)
@@@@@@@@@@ @@@@@@@@@
```
## Installation
Vivid is [available in Hex](https://hex.pm/packages/vivid), the package can be
installed by adding `vivid` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:vivid, "~> 0.4.4"}
]
end
```
Documentation for the latest release can be found on
[HexDocs](https://hexdocs.pm/vivid) and for the `main` branch on
[docs.harton.nz](https://docs.harton.nz/james/vivid).
## Github Mirror
This repository is mirrored [on Github](https://github.com/jimsynz/vivid)
from it's primary location [on my Forejo instance](https://harton.dev/james/vivid).
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

12
mix.exs
View file

@ -14,12 +14,14 @@ defmodule Vivid.Mixfile do
start_permanent: Mix.env() == :prod,
package: package(),
deps: deps(),
source_url: "https://harton.dev/james/vivid",
homepage_url: "https://harton.dev/james/vivid",
docs: [
source_ref: "v#{@version}",
main: "Vivid",
canonical: "http://hexdocs.pm/vivid",
source_url: "https://harton.dev/james/vivid",
extras: ["guides/getting-started.md"]
extras: ["guides/getting-started.md", "README.md", "CHANGELOG.md"]
]
]
end
@ -42,8 +44,12 @@ defmodule Vivid.Mixfile do
maintainers: ["James Harton <james@harton.nz>"],
licenses: ["MIT"],
links: %{
"Source" => "https://harton.dev/james/vivid"
}
"Source" => "https://harton.dev/james/vivid",
"GitHub" => "https://github.com/jimsynz/vivid",
"Changelog" => "https://docs.harton.nz/james/vivid/changelog.html",
"Sponsor" => "https://github.com/sponsors/jimsynz"
},
source_url: "https://harton.dev/james/vivid"
]
end