From 8be3f49dcc10cb62857dcb594b535bc2e0cf9ab4 Mon Sep 17 00:00:00 2001 From: Henry Popp Date: Sat, 28 Dec 2024 10:22:33 -0600 Subject: [PATCH] refactor: tweak description --- README.md | 2 +- lib/pigeon.ex | 2 +- mix.exs | 13 ++++--------- 3 files changed, 6 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index b9877b2..f94816c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ ![logo](https://raw.githubusercontent.com/codedge-llc/pigeon/master/docs/logo.png) -> HTTP2-compliant wrapper for sending iOS and Android push notifications. +> iOS (APNS), Android (FCM), and Amazon Android (ADM) push notifications for Elixir. [![CI](https://github.com/codedge-llc/pigeon/actions/workflows/ci.yml/badge.svg)](https://github.com/codedge-llc/pigeon/actions/workflows/ci.yml) [![Version](https://img.shields.io/hexpm/v/pigeon.svg)](https://hex.pm/packages/pigeon) diff --git a/lib/pigeon.ex b/lib/pigeon.ex index 06934c3..b6b1138 100644 --- a/lib/pigeon.ex +++ b/lib/pigeon.ex @@ -1,6 +1,6 @@ defmodule Pigeon do @moduledoc """ - HTTP2-compliant wrapper for sending iOS and Android push notifications. + iOS (APNS), Android (FCM), and Amazon Android (ADM) push notifications for Elixir. ## Getting Started diff --git a/mix.exs b/mix.exs index e76b922..6f91573 100644 --- a/mix.exs +++ b/mix.exs @@ -1,6 +1,8 @@ defmodule Pigeon.Mixfile do use Mix.Project + @description "iOS (APNS), Android (FCM), and Amazon Android (ADM) push notifications for Elixir." + @name "Pigeon" @source_url "https://github.com/codedge-llc/pigeon" @version "2.0.1" @@ -9,13 +11,13 @@ defmodule Pigeon.Mixfile do app: :pigeon, build_embedded: Mix.env() == :prod, deps: deps(), - description: description(), + description: @description, dialyzer: dialyzer(), docs: docs(), elixir: "~> 1.7", elixirc_options: [warnings_as_errors: true], elixirc_paths: elixirc_paths(Mix.env()), - name: "Pigeon", + name: @name, package: package(), preferred_cli_env: [ coveralls: :test, @@ -79,13 +81,6 @@ defmodule Pigeon.Mixfile do ] end - defp description do - """ - HTTP2-compliant wrapper for sending iOS (APNS), Android (FCM), - and Amazon Android (ADM) push notifications. - """ - end - defp package do [ files: ["lib", "mix.exs", "README*", "LICENSE*", "CHANGELOG*"],