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.
9 Commits 1 Branch 60 Tags 8.4 MiB
Go 99.1%
Makefile 0.9%
9df832cd3e
Go to file
Niko Köser 9df832cd3e
docs(comment): add missing comment to pseudo struct
2021-01-26 09:21:47 +01:00
service docs(comment): add missing comment to pseudo struct 2021-01-26 09:21:47 +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: go mod tidy 2021-01-25 05:05:00 +01:00
go.sum chore: go mod tidy 2021-01-25 05:05:00 +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 wip note 2021-01-25 06:08:37 +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

Welcome to notify (WIP) 👋

GitHub tag (latest SemVer) Lines of code License: MIT

A dead simple Go library for sending notifications to various messaging 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! :)",
)

Roadmap

  • Add tests
  • Add more notification services

Libraries in use

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!

This README was generated with ❤️ by readme-md-generator