From 2f8eaa0f613814d5da3c1281362f0c19b4be833e Mon Sep 17 00:00:00 2001
From: James Harton <james@harton.nz>
Date: Thu, 7 Mar 2024 19:57:58 +1300
Subject: [PATCH] chore: Update readme and package links.

---
 README.md | 35 +++++++++++++----------------------
 mix.exs   | 10 ++++++++--
 2 files changed, 21 insertions(+), 24 deletions(-)

diff --git a/README.md b/README.md
index 44a0d5a..76f96f0 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # 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)
 [![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
 
-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
-   def deps do
-     [{:heap, "~> 2.0"}]
-   end
-   ```
-
-2. Run `mix deps.get`
+Documentation for the latest release can be found on
+[HexDocs](https://hexdocs.pm/heap) and for the `main` branch on
+[docs.harton.nz](https://docs.harton.nz/james/heap).
 
 ## Deprecation warning
 
@@ -86,18 +89,6 @@ To access the root and the rest of the heap in one line use `Heap.split/1`:
 # => 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
 
 This software is licensed under the terms of the
diff --git a/mix.exs b/mix.exs
index 55c0a44..1149be8 100644
--- a/mix.exs
+++ b/mix.exs
@@ -12,7 +12,11 @@ defmodule Heap.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
 
@@ -33,7 +37,9 @@ defmodule Heap.Mixfile do
       licenses: ["HL3-FULL"],
       links: %{
         "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