From b272da9f1dfb08584910616f7cbb924cc1c903ef Mon Sep 17 00:00:00 2001
From: Henry Popp <henry@codedge.io>
Date: Tue, 10 Sep 2024 16:44:00 -0500
Subject: [PATCH] docs: add CHANGELOG

Also: README and hex docs tweaks.
---
 CHANGELOG.md | 10 ++++++++++
 README.md    | 12 ++++++++----
 mix.exs      | 27 ++++++++++++---------------
 3 files changed, 30 insertions(+), 19 deletions(-)
 create mode 100644 CHANGELOG.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..9b647ca
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## v0.1.0 - 2024-09-10
+
+Initial release.
diff --git a/README.md b/README.md
index df8fbc7..043fb61 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,13 @@
-[![CI](https://github.com/codedge-llc/pigeon-legacy-fcm/actions/workflows/ci.yml/badge.svg)](https://github.com/codedge-llc/pigeon-legacy-fcm/actions/workflows/ci.yml)
-
 # Pigeon Legacy FCM
 
 > Pigeon adapter for Firebase Cloud Messaging Legacy API.
 
+[![CI](https://github.com/codedge-llc/pigeon-legacy-fcm/actions/workflows/ci.yml/badge.svg)](https://github.com/codedge-llc/pigeon-legacy-fcm/actions/workflows/ci.yml)
+[![Version](https://img.shields.io/hexpm/v/pigeon-legacy-fcm.svg)](https://hex.pm/packages/pigeon-legacy-fcm)
+[![License](https://img.shields.io/hexpm/l/pigeon-legacy-fcm.svg)](https://github.com/codedge-llc/pigeon-legacy-fcm/blob/main/LICENSE)
+[![Last Updated](https://img.shields.io/github/last-commit/codedge-llc/pigeon-legacy-fcm.svg)](https://github.com/codedge-llc/pigeon-legacy-fcm/commits/main)
+[![Documentation](https://img.shields.io/badge/documentation-gray)](https://hexdocs.pm/pigeon-legacy-fcm/)
+
 ## Installation
 
 Add `:pigeon` and `:pigeon_legacy_fcm` as `mix.exs` dependencies:
@@ -11,7 +15,7 @@ Add `:pigeon` and `:pigeon_legacy_fcm` as `mix.exs` dependencies:
 ```elixir
 def deps do
   [
-    {:pigeon, "~> 2.0.0-rc.2"},
+    {:pigeon, "~> 2.0.0-rc.3"},
     {:pigeon_legacy_fcm, "~> 0.1.0"}
   ]
 end
@@ -21,7 +25,7 @@ end
 
 Check the module documentation:
 
-- [Pigeon.LegacyFCM](https://hexdocs.pm/pigeon/2.0.0-rc.2/Pigeon.LegacyFCM.html) - Firebase Cloud Messaging Legacy API.
+- [Pigeon.LegacyFCM](https://hexdocs.pm/pigeon_legacy_fcm/Pigeon.LegacyFCM.html) - Firebase Cloud Messaging Legacy API.
 
 ## Contributing
 
diff --git a/mix.exs b/mix.exs
index 77327fd..49da889 100644
--- a/mix.exs
+++ b/mix.exs
@@ -9,7 +9,6 @@ defmodule Pigeon.LegacyFCM.Mixfile do
       app: :pigeon_legacy_fcm,
       build_embedded: Mix.env() == :prod,
       deps: deps(),
-      description: description(),
       dialyzer: dialyzer(),
       docs: docs(),
       elixir: "~> 1.7",
@@ -55,29 +54,27 @@ defmodule Pigeon.LegacyFCM.Mixfile do
 
   defp docs do
     [
-      groups_for_modules: [
-        "Legacy Firebase Cloud Messaging": [
-          Pigeon.LegacyFCM,
-          Pigeon.LegacyFCM.Notification
-        ]
+      extras: [
+        "CHANGELOG.md",
+        LICENSE: [title: "License"]
       ],
-      main: "Pigeon.LegacyFCM"
+      formatters: ["html"],
+      main: "Pigeon.LegacyFCM",
+      skip_undefined_reference_warnings_on: ["CHANGELOG.md"],
+      source_ref: "v#{@version}",
+      source_url: @source_url
     ]
   end
 
-  defp description do
-    """
-    Pigeon adapter for Firebase Cloud Messaging Legacy API.
-    """
-  end
-
   defp package do
     [
-      files: ["lib", "mix.exs", "README*", "LICENSE*"],
+      description: "Pigeon adapter for Firebase Cloud Messaging Legacy API.",
+      files: ["lib", "mix.exs", "README*", "LICENSE*", "CHANGELOG*"],
       licenses: ["MIT"],
       links: %{
         "Changelog" => "https://hexdocs.pm/pigeon-legacy-fcm/changelog.html",
-        "GitHub" => @source_url
+        "GitHub" => "https://github.com/codedge-llc/pigeon-legacy-fcm",
+        "Sponsor" => "https://github.com/sponsors/codedge-llc"
       },
       maintainers: ["Henry Popp"]
     ]