Skip to content
Notification package for go
Go
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github setup python 3 Mar 29, 2020
cmd/shoutrrr cleanup: use Params type and simplify router API Jul 26, 2019
docs feat(services) add mattermost service Mar 30, 2020
internal fix(lint): additional lint fixes Jul 26, 2019
pkg move import Mar 30, 2020
.gitignore deploy docs using mkocs Mar 29, 2020
CONTRIBUTING.md Update CONTRIBUTING.md Jul 26, 2019
LICENSE refactor: restructure and tidy up Jul 18, 2019
README.md Shorten readme and point at the docs Mar 30, 2020
build.sh fix: add shebang to build script Jul 26, 2019
go.mod
go.sum
mkdocs.yml deploy docs using mkocs Mar 29, 2020
shoutrrr.go cleanup: use Params type and simplify router API Jul 26, 2019

README.md

Shoutrrr

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

codacy coverage codacy grade GitHub code size in bytes license GoDoc

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 := 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.

You can’t perform that action at this time.