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 ff531ac..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", @@ -49,39 +48,33 @@ defmodule Pigeon.LegacyFCM.Mixfile do {:ex_doc, ">= 0.0.0", only: :dev, runtime: false}, {:jason, "~> 1.0", optional: true}, {:joken, "~> 2.1"}, - {:pigeon, github: "codedge-llc/pigeon", branch: "feat/remove-legacy-fcm"} + {:pigeon, "~> 2.0.0-rc.3"} ] end defp docs do [ - groups_for_modules: [ - "ADM - Amazon Android": [Pigeon.ADM, Pigeon.ADM.Notification], - "APNS - Apple iOS": [Pigeon.APNS, Pigeon.APNS.Notification], - "FCM - Firebase Cloud Messaging": [ - Pigeon.FCM, - Pigeon.FCM.Notification, - Pigeon.LegacyFCM, - Pigeon.LegacyFCM.Notification - ] + extras: [ + "CHANGELOG.md", + LICENSE: [title: "License"] ], - main: "Pigeon" + 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"] ] diff --git a/mix.lock b/mix.lock index fcf7037..910766b 100644 --- a/mix.lock +++ b/mix.lock @@ -32,7 +32,7 @@ "nimble_parsec": {:hex, :nimble_parsec, "1.4.0", "51f9b613ea62cfa97b25ccc2c1b4216e81df970acd8e16e8d1bdc58fef21370d", [:mix], [], "hexpm", "9c565862810fb383e9838c1dd2d7d2c437b3d13b267414ba6af33e50d2d1cf28"}, "nimble_pool": {:hex, :nimble_pool, "1.1.0", "bf9c29fbdcba3564a8b800d1eeb5a3c58f36e1e11d7b7fb2e084a643f645f06b", [:mix], [], "hexpm", "af2e4e6b34197db81f7aad230c1118eac993acc0dae6bc83bac0126d4ae0813a"}, "parse_trans": {:hex, :parse_trans, "3.4.2", "c352ddc1a0d5e54f9b1654d45f9c432eef76f9cea371c55ddff769ef688fdb74", [:rebar3], [], "hexpm", "4c25347de3b7c35732d32e69ab43d1ceee0beae3f3b3ade1b59cbd3dd224d9ca"}, - "pigeon": {:git, "https://github.com/codedge-llc/pigeon.git", "be16d98ca26d040695a1a72e6eed1333f7bb6912", [branch: "feat/remove-legacy-fcm"]}, + "pigeon": {:hex, :pigeon, "2.0.0-rc.3", "b079e0bc1e7edc430361762848e1c93c11c541ea97f94cef9b8deca452ad1a74", [:mix], [{:goth, "~> 1.4.3", [hex: :goth, repo: "hexpm", optional: false]}, {:httpoison, "~> 1.0 or ~> 2.0", [hex: :httpoison, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: true]}, {:joken, "~> 2.1", [hex: :joken, repo: "hexpm", optional: false]}, {:kadabra, "~> 0.6.0", [hex: :kadabra, repo: "hexpm", optional: false]}], "hexpm", "2fc03dad11816b3634b31123193d33462904c72515be9c1674d4926034f16bbb"}, "ssl_verify_fun": {:hex, :ssl_verify_fun, "1.1.7", "354c321cf377240c7b8716899e182ce4890c5938111a1296add3ec74cf1715df", [:make, :mix, :rebar3], [], "hexpm", "fe4c190e8f37401d30167c8c405eda19469f34577987c76dde613e838bbc67f8"}, "telemetry": {:hex, :telemetry, "1.3.0", "fedebbae410d715cf8e7062c96a1ef32ec22e764197f70cda73d82778d61e7a2", [:rebar3], [], "hexpm", "7015fc8919dbe63764f4b4b87a95b7c0996bd539e0d499be6ec9d7f3875b79e6"}, "unicode_util_compat": {:hex, :unicode_util_compat, "0.7.0", "bc84380c9ab48177092f43ac89e4dfa2c6d62b40b8bd132b1059ecc7232f9a78", [:rebar3], [], "hexpm", "25eee6d67df61960cf6a794239566599b09e17e668d3700247bc498638152521"},