Rename app

Author: adriankumpf

Makefile

@@ -4,8 +4,17 @@ help:
 	sort | \
 	awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
 
+.PHONY: format
 format: ## Format the whole codabase with the upcoming formatter
 	@docker run \
 	--rm --name elixir_dev -it \
 	-v $(shell pwd):/app leifg/elixir:edge \
 	sh -c "cd /app && mix format ${FILE}"
+
+.PHONY: publish-package
+publish-package: ## Publish the package
+	@mix hex.publish package
+
+.PHONY: publish-docs
+publish-docs: ## Publish the documentation
+	@mix hex.publish docs

README.md

@@ -1,16 +1,14 @@
-# TelegramLoggerBackend
+# LoggerTelegramBackend
 
-A logger backend for posting messages to [Telegram]( https://telegram.org/).
+A logger backend for [Telegram]( https://telegram.org/).
 
 ## Installation
 
-**Note: this package is still in beta and thus not yet available on hex**
-
-Add `:telegram_logger_backend` to your list of dependencies in `mix.exs`:
+Add `:logger_telegram_backend` to your list of dependencies in `mix.exs`:
 
 ```elixir
 def deps do
-  [{:telegram_logger_backend, "~> 0.4"}]
+  [{:logger_telegram_backend, "~> 1.0"}]
 end
 ```
 
@@ -23,11 +21,11 @@ here](https://core.telegram.org/bots#6-botfather) to create one and get the
 send a message first. Afterwards, retrieve your `chat_id` with `$ curl -X GET
 https://api.telegram.org/botYOUR_TOKEN/getUpdates`.
 
-Then add `TelegramLoggerBackend` to the `:backends` configuration and configure
-the telegram `chat_id` and bot `token` as well:
+Then add `LoggerTelegramBackend` to the `:backends` configuration, configure
+the telegram `chat_id` and bot `token`:
 
 ```elixir
-config :logger, backends: [TelegramLoggerBackend, :console]
+config :logger, backends: [LoggerTelegramBackend, :console]
 
 config :logger, :telegram,
   chat_id: "$chatId",
@@ -41,7 +39,7 @@ with environment variables.
 
 ### Options
 
-In addition, the following options are available:
+The following options are available:
 
   * `:level` - the level to be logged by this backend (either `:debug`,
     `:info`, `:warn` or `:error`). Note that messages are filtered by the
@@ -70,13 +68,13 @@ config :logger, :telegram,
 Like the
 [LoggerFileBackend](https://github.com/onkel-dirtus/logger_file_backend)
 multiple logger handlers may be configured, each with different `:chat_id`s,
-`:level`s etc. Each handler has to be configured as a logger backend:
+`:level`s etc. Each handler has to be configured as a separate logger backend:
 
 ```elixir
 config :logger,
   backends: [
-    {TelegramLoggerBackend, :telegram_filter},
-    {TelegramLoggerBackend, :telegram_level},
+    {LoggerTelegramBackend, :telegram_filter},
+    {LoggerTelegramBackend, :telegram_level},
     :console
   ]
 

lib/telegram_logger_backend.ex

@@ -1,4 +1,4 @@
-defmodule TelegramLoggerBackend do
+defmodule LoggerTelegramBackend do
   @moduledoc """
   A logger backend for posting messages to [Telegram]( https://telegram.org/).
   """
@@ -7,8 +7,8 @@ defmodule TelegramLoggerBackend do
 
   defstruct [:name, :level, :metadata, :metadata_filter, :sender, :sender_args]
 
-  alias TelegramLoggerBackend.Sender.Telegram
-  alias TelegramLoggerBackend.Manager
+  alias LoggerTelegramBackend.Sender.Telegram
+  alias LoggerTelegramBackend.Manager
 
   @default_name :telegram
   @default_sender {Telegram, [:token, :chat_id]}

lib/telegram_logger_backend/application.ex

@@ -1,9 +1,9 @@
-defmodule TelegramLoggerBackend.Application do
+defmodule LoggerTelegramBackend.Application do
   @moduledoc false
 
   use Application
 
-  alias TelegramLoggerBackend.{Formatter, Manager, Sender}
+  alias LoggerTelegramBackend.{Formatter, Manager, Sender}
 
   def start(_type, _args) do
     children = [
@@ -17,7 +17,7 @@ defmodule TelegramLoggerBackend.Application do
       strategy: :one_for_one,
       max_restarts: 5,
       max_seconds: 30,
-      name: TelegramLoggerBackend.Supervisor
+      name: LoggerTelegramBackend.Supervisor
     )
   end
 end

lib/telegram_logger_backend/formatter.ex

@@ -1,9 +1,9 @@
-defmodule TelegramLoggerBackend.Formatter do
+defmodule LoggerTelegramBackend.Formatter do
   @moduledoc false
 
   use GenStage
 
-  alias TelegramLoggerBackend.Manager
+  alias LoggerTelegramBackend.Manager
 
   @name __MODULE__
 

lib/telegram_logger_backend/manager.ex

@@ -1,4 +1,4 @@
-defmodule TelegramLoggerBackend.Manager do
+defmodule LoggerTelegramBackend.Manager do
   @moduledoc false
 
   use GenStage

lib/telegram_logger_backend/sender.ex

@@ -1,9 +1,9 @@
-defmodule TelegramLoggerBackend.Sender do
+defmodule LoggerTelegramBackend.Sender do
   @moduledoc false
 
   use GenStage
 
-  alias TelegramLoggerBackend.Formatter
+  alias LoggerTelegramBackend.Formatter
 
   @name __MODULE__
 

lib/telegram_logger_backend/sender/telegram.ex

@@ -1,4 +1,4 @@
-defmodule TelegramLoggerBackend.Sender.Telegram do
+defmodule LoggerTelegramBackend.Sender.Telegram do
   @moduledoc false
 
   @base_url "https://api.telegram.org"

mix.exs

@@ -1,27 +1,28 @@
-defmodule TelegramLoggerBackend.Mixfile do
+defmodule LoggerTelegramBackend.Mixfile do
   use Mix.Project
 
   def project do
     [
-      app: :telegram_logger_backend,
-      version: "0.4.0",
+      app: :logger_telegram_backend,
+      version: "1.0.0",
       elixir: "~> 1.5",
       start_permanent: Mix.env() == :prod,
       deps: deps(),
       package: package(),
 
       # Docs
-      name: "TelegramLoggerBackend",
-      description: " A logger backend for posting messages to Telegram.",
-      source_url: "https://github.com/adriankumpf/telegram-logger-backend",
+      name: "LoggerTelegramBackend",
+      description: "A Logger backend for Telegram",
+      source_url: "https://github.com/adriankumpf/logger-telegram-backend",
+      homepage_url: "https://github.com/adriankumpf/logger-telegram-backend",
       docs: [main: "readme", extras: ["README.md"]]
     ]
   end
 
   def application do
     [
       extra_applications: [:logger],
-      mod: {TelegramLoggerBackend.Application, []}
+      mod: {LoggerTelegramBackend.Application, []}
     ]
   end
 
@@ -38,7 +39,7 @@ defmodule TelegramLoggerBackend.Mixfile do
   defp package do
     [
       licenses: ["MIT"],
-      links: %{"GitHub" => "https://github.com/adriankumpf/telegram-logger-backend"},
+      links: %{"GitHub" => "https://github.com/adriankumpf/logger-telegram-backend"},
       maintainers: ["Adrian Kumpf"]
     ]
   end

mix.lock

@@ -4,7 +4,7 @@
   "exactor": {:hex, :exactor, "2.2.4", "5efb4ddeb2c48d9a1d7c9b465a6fffdd82300eb9618ece5d34c3334d5d7245b1", [:mix], [], "hexpm"},
   "exjsx": {:hex, :exjsx, "4.0.0", "60548841e0212df401e38e63c0078ec57b33e7ea49b032c796ccad8cde794b5c", [:mix], [{:jsx, "~> 2.8.0", [hex: :jsx, repo: "hexpm", optional: false]}], "hexpm"},
   "exvcr": {:hex, :exvcr, "0.9.1", "31e3936a790a14bf56b31b6b276577076a5ef8afd9b2d53ba3ff8bb647d45613", [:mix], [{:exactor, "~> 2.2", [hex: :exactor, repo: "hexpm", optional: false]}, {:exjsx, "~> 4.0", [hex: :exjsx, repo: "hexpm", optional: false]}, {:httpoison, "~> 0.13", [hex: :httpoison, repo: "hexpm", optional: true]}, {:httpotion, "~> 3.0", [hex: :httpotion, repo: "hexpm", optional: true]}, {:ibrowse, "~> 4.4", [hex: :ibrowse, repo: "hexpm", optional: true]}, {:meck, "~> 0.8.8", [hex: :meck, repo: "hexpm", optional: false]}], "hexpm"},
-  "gen_stage": {:hex, :gen_stage, "0.12.2", "e0e347cbb1ceb5f4e68a526aec4d64b54ad721f0a8b30aa9d28e0ad749419cbb", [:mix], [], "hexpm"},
+  "gen_stage": {:hex, :gen_stage, "0.13.0", "09c85d9939d4dce88e8819fd235ce411990abaf1bc24bd5a824e851439aedc15", [:mix], [], "hexpm"},
   "hackney": {:hex, :hackney, "1.10.1", "c38d0ca52ea80254936a32c45bb7eb414e7a96a521b4ce76d00a69753b157f21", [:rebar3], [{:certifi, "2.0.0", [hex: :certifi, repo: "hexpm", optional: false]}, {:idna, "5.1.0", [hex: :idna, repo: "hexpm", optional: false]}, {:metrics, "1.0.1", [hex: :metrics, repo: "hexpm", optional: false]}, {:mimerl, "1.0.2", [hex: :mimerl, repo: "hexpm", optional: false]}, {:ssl_verify_fun, "1.1.1", [hex: :ssl_verify_fun, repo: "hexpm", optional: false]}], "hexpm"},
   "httpoison": {:hex, :httpoison, "0.13.0", "bfaf44d9f133a6599886720f3937a7699466d23bb0cd7a88b6ba011f53c6f562", [:mix], [{:hackney, "~> 1.8", [hex: :hackney, repo: "hexpm", optional: false]}], "hexpm"},
   "idna": {:hex, :idna, "5.1.0", "d72b4effeb324ad5da3cab1767cb16b17939004e789d8c0ad5b70f3cea20c89a", [:rebar3], [{:unicode_util_compat, "0.3.1", [hex: :unicode_util_compat, repo: "hexpm", optional: false]}], "hexpm"},