shoutrrr

README

Shoutrrr

Notification library for gophers and their furry friends. Heavily inspired by caronc/apprise.

Quick Start

As a package

Using shoutrrr is easy! There is currently two ways of using it as a package.

Using the direct send command

  url := "slack://token-a/token-b/token-c"
  err := shoutrrr.Send(url, "Hello world (or slack channel) !")

Using a sender

  url := "slack://token-a/token-b/token-c"
  sender, err := shoutrrr.CreateSender(url)
  sender.Send("Hello world (or slack channel) !", map[string]string { /* ... */ })

Through the CLI

Start by running the build.sh script. You may then run send notifications using the shoutrrr executable:

$ shoutrrr send [OPTIONS] <URL> <Message [...]>

Documentation

For additional details, visit the full documentation.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Amir Schnell 💻

nils måsén 💻 📖 🚧

Luka Peschke 💻 📖

MrLuje 💻 📖

Simon Aronsson 💻 📖 🚧

Arne Jørgensen 📖 💻

This project follows the all-contributors specification. Contributions of any kind welcome!

Documentation

Index

• func CreateSender(rawURLs ...string) (*router.ServiceRouter, error)
• func Send(rawURL string, message string) error
• func SetLogger(logger *log.Logger)

Functions

func CreateSender

func CreateSender(rawURLs ...string) (*router.ServiceRouter, error)

CreateSender returns a notification sender configured according to the supplied URL

func Send

func Send(rawURL string, message string) error

Send notifications using a supplied url and message

func SetLogger

func SetLogger(logger *log.Logger)

SetLogger sets the logger that the services will use to write progress logs