From 18b0ac6b8e46f48e1e3d868c9492b6b032a8c9eb Mon Sep 17 00:00:00 2001 From: Henry Popp Date: Sun, 8 Dec 2024 18:47:26 -0600 Subject: [PATCH] docs: more tweaks --- CHANGELOG.md | 2 +- README.md | 10 +++++----- docs/Migrating to v2-0-0.md | 2 +- mix.exs | 3 ++- 4 files changed, 9 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4176419..8c664b5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,7 @@ ## v2.0.0 -No additional changes since v2.0.0-rc.3. +No additional changes since v2.0.0-rc.3. Stable release. ## v2.0.0-rc.3 diff --git a/README.md b/README.md index f539eeb..f558809 100644 --- a/README.md +++ b/README.md @@ -29,22 +29,22 @@ See the [migration guide](./docs/Migrating to v2-0-0.md) for instructions. Check the module documentation for your push notification service. -- [Pigeon.ADM](https://hexdocs.pm/pigeon/2.0.0/Pigeon.ADM.html) - Amazon Android. -- [Pigeon.APNS](https://hexdocs.pm/pigeon/2.0.0/Pigeon.APNS.html) - Apple iOS. -- [Pigeon.FCM](https://hexdocs.pm/pigeon/2.0.0/Pigeon.FCM.html) - Firebase Cloud Messaging v1 API. +- [Pigeon.ADM](https://hexdocs.pm/pigeon/Pigeon.ADM.html) - Amazon Android. +- [Pigeon.APNS](https://hexdocs.pm/pigeon/Pigeon.APNS.html) - Apple iOS. +- [Pigeon.FCM](https://hexdocs.pm/pigeon/Pigeon.FCM.html) - Firebase Cloud Messaging v1 API. ### Creating Dynamic Runtime Dispatchers Pigeon can spin up dynamic dispatchers for a variety of advanced use-cases, such as supporting dozens of dispatcher configurations or custom connection pools. -See [Pigeon.Dispatcher](https://hexdocs.pm/pigeon/2.0.0/Pigeon.Dispatcher.html) for instructions. +See [Pigeon.Dispatcher](https://hexdocs.pm/pigeon/Pigeon.Dispatcher.html) for instructions. ### Writing a Custom Dispatcher Adapter Want to write a Pigeon adapter for an unsupported push notification service? -See [Pigeon.Adapter](https://hexdocs.pm/pigeon/2.0.0/Pigeon.Adapter.html) for instructions. +See [Pigeon.Adapter](https://hexdocs.pm/pigeon/Pigeon.Adapter.html) for instructions. ## Contributing diff --git a/docs/Migrating to v2-0-0.md b/docs/Migrating to v2-0-0.md index 9dce672..6450c38 100644 --- a/docs/Migrating to v2-0-0.md +++ b/docs/Migrating to v2-0-0.md @@ -2,7 +2,7 @@ ## Migrating from v2.0 RCs -See the [CHANGELOG](./CHANGELOG.md) for specific breaking changes from each RC. If upgrading from RC3, +See the [CHANGELOG](../CHANGELOG.md) for specific breaking changes from each RC. If upgrading from RC3, no additional changes are required. ## Migrating from v1.6 diff --git a/mix.exs b/mix.exs index 4b79e92..7cd5eab 100644 --- a/mix.exs +++ b/mix.exs @@ -60,7 +60,8 @@ defmodule Pigeon.Mixfile do [ extras: [ "CHANGELOG.md", - LICENSE: [title: "License"] + LICENSE: [title: "License"], + "docs/Migrating to v2-0-0.md": [title: "Upgrading to v2.0"] ], groups_for_modules: [ "ADM - Amazon Android": [Pigeon.ADM, Pigeon.ADM.Notification],