go/notify
1
0
Fork 0
mirror of https://github.com/nikoksr/notify.git synced 2024-11-24 08:22:18 +02:00
Code Issues Releases Activity
A dead simple Go library for sending notifications to various messaging services.
16 Commits 1 Branch 60 Tags 8.4 MiB
Go 99.1%
Makefile 0.9%
c36622c2f6
Go to file
Niko Köser c36622c2f6
docs(readme): add list of supported services
2021-01-26 11:31:14 +01:00
.github ci(gh): add templates for PR, bug- and feature-request 2021-01-26 10:36:10 +01:00
assets docs(readme): refactor readme 2021-01-26 10:45:14 +01:00
service fix(discord): add gateway intent to discord client 2021-01-26 09:22:55 +01:00
.editorconfig feat: init project 2021-01-25 00:14:21 +01:00
.gitignore feat: init project 2021-01-25 00:14:21 +01:00
.golangci.yml feat: init project 2021-01-25 00:14:21 +01:00
CODE_OF_CONDUCT.md docs: add readme, coc, and contrib guidelines 2021-01-25 05:05:59 +01:00
CONTRIBUTING.md docs: add readme, coc, and contrib guidelines 2021-01-25 05:05:59 +01:00
go.mod chore(deps): go mod tidy 2021-01-26 09:26:11 +01:00
go.sum chore(deps): go mod tidy 2021-01-26 09:26:11 +01:00
LICENSE feat: init project 2021-01-25 00:14:21 +01:00
notify.go refactor(lib): comment and clean up code 2021-01-25 05:05:28 +01:00
README.md docs(readme): add list of supported services 2021-01-26 11:31:14 +01:00
send.go refactor(lib): comment and clean up code 2021-01-25 05:05:28 +01:00
use.go refactor(lib): comment and clean up code 2021-01-25 05:05:28 +01:00

README.md

notify logo

GitHub tag (latest SemVer) Go Report Card Codacy Badge Maintainability go.dev reference

A dead simple Go library for sending notifications to various messaging platforms.

About

Notify arose from my own need for one of my api server running in production to be able to notify me when, for example, an error occurred. The library is kept as simple as possible to allow a quick integration and easy usage.

Disclaimer

Any misuse of this library is your own liability and responsibility and cannot be attributed to the authors of this library. See license for more.

Spamming through the use of this library may get you permanently banned on most supported platforms.

Install 

go get -u github.com/nikoksr/notify

Example usage 

// The notifier we're gonna send our messages to
notifier := notify.New()

// Create a telegram service. Ignoring error for demo simplicity
telegramService, _ := telegram.New("your_telegram_api_token")

// Passing a telegram chat id as receiver for our messages.
// Basically where should our message be sent to?
telegramService.AddReceivers(-1234567890)

// Tell our notifier to use the telegram service. You can repeat the above process
// for as many services as you like and just tell the notifier to use them.
// Its kinda like using middlewares for api servers.
notifier.UseService(telegramService)

// Send a test message
_ = notifier.Send(
	"Message Subject/Title",
	"The actual message. Hello, you awesome gophers! :)",
)

Supported services

  • Discord
  • Email
  • Telegram

Roadmap

  • Add tests
  • Add more notification services

Credits

Author

Niko Köser

Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page. You can also take a look at the contributing guide.

Show your support

Give a ⭐️ if this project helped you!