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

This commit is contained in:
James Harton 2024-03-07 19:57:58 +13:00
parent 4b4edc8a85
commit 2f8eaa0f61
Signed by: james
GPG key ID: 90E82DAA13F624F4
2 changed files with 21 additions and 24 deletions

View file

@ -1,6 +1,6 @@
# Heap # Heap
[![Build Status](https://drone.harton.nz/api/badges/james/heap/status.svg?ref=refs/heads/main)](https://drone.harton.nz/james/heap) [![Build Status](https://drone.harton.dev/api/badges/james/heap/status.svg?ref=refs/heads/main)](https://drone.harton.dev/james/heap)
[![Hex.pm](https://img.shields.io/hexpm/v/heap.svg)](https://hex.pm/packages/heap) [![Hex.pm](https://img.shields.io/hexpm/v/heap.svg)](https://hex.pm/packages/heap)
[![Hippocratic License HL3-FULL](https://img.shields.io/static/v1?label=Hippocratic%20License&message=HL3-FULL&labelColor=5e2751&color=bc8c3d)](https://firstdonoharm.dev/version/3/0/full.html) [![Hippocratic License HL3-FULL](https://img.shields.io/static/v1?label=Hippocratic%20License&message=HL3-FULL&labelColor=5e2751&color=bc8c3d)](https://firstdonoharm.dev/version/3/0/full.html)
@ -16,17 +16,20 @@ You can use it for things like:
## Installation ## Installation
This package is [available in Hex](https://hex.pm/packages/heap): Heap is [available in Hex](https://hex.pm/packages/heap), the package can be
installed by adding `heap` to your list of dependencies in `mix.exs`:
1. Add heap to your list of dependencies in `mix.exs`: ```elixir
def deps do
[
{:heap, "~> 3.0.0"}
]
end
```
```elixir Documentation for the latest release can be found on
def deps do [HexDocs](https://hexdocs.pm/heap) and for the `main` branch on
[{:heap, "~> 2.0"}] [docs.harton.nz](https://docs.harton.nz/james/heap).
end
```
2. Run `mix deps.get`
## Deprecation warning ## Deprecation warning
@ -86,18 +89,6 @@ To access the root and the rest of the heap in one line use `Heap.split/1`:
# => true # => true
``` ```
### Documentation
Full API documentation is available on (hexdocs.pm)[https://hexdocs.pm/heap]
## Contributing
1. Fork it ( https://harton.dev/repo/fork/50 )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
## License ## License
This software is licensed under the terms of the This software is licensed under the terms of the

10
mix.exs
View file

@ -12,7 +12,11 @@ defmodule Heap.Mixfile do
build_embedded: Mix.env() == :prod, build_embedded: Mix.env() == :prod,
start_permanent: Mix.env() == :prod, start_permanent: Mix.env() == :prod,
package: package(), package: package(),
deps: deps() deps: deps(),
docs: [
main: "readme",
extras: ["README.md", "CHANGELOG.md"]
]
] ]
end end
@ -33,7 +37,9 @@ defmodule Heap.Mixfile do
licenses: ["HL3-FULL"], licenses: ["HL3-FULL"],
links: %{ links: %{
"Repository" => "https://harton.dev/james/heap", "Repository" => "https://harton.dev/james/heap",
"Docs" => "https://hexdocs.pm/heap" "GitHub" => "https://github.com/jimsynz/heap",
"Changelog" => "https://docs.harton.nz/james/heap/changelog.html",
"Sponsor" => "https://github.com/sponsors/jimsynz"
} }
] ]
end end