Mirrors
/
prologic-msgbus
mirror of https://git.mills.io/prologic/msgbus.git
6
0
Fork 0
Code Issues Projects Releases Wiki Activity

Document use-cases

This commit is contained in:
James Mills 2018-05-05 14:45:39 -07:00
parent fba29f436b
commit b5862245e1
No known key found for this signature in database
GPG Key ID: AC4C014F1440EBD6
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -17,6 +17,20 @@ consistency and reliability guarantees.
$ go install github.com/prologic/msgbus/...
```
## Use Cases
* As a simple generic webhook
You can use msgbus as a simple generic webhook. For example in my
[dockerfiles](https://github.com/prologic/dockerfiles) repo I have hooked up
[Prometheus](https://prometheus.io/)'s [AlertManager](https://prometheus.io/docs/alerting/alertmanager/)
to send alert notifications to an IRC channel using some simple shell scripts.
See: [alert](https://hub.docker.com/r/prologic/alert/)
* As a general-purpose message / event bus that supports pub/sub as well as
pulling messages synchronously.
## Usage (library)
Install the package into your project: