mirror of
https://github.com/asaskevich/EventBus.git
synced 2025-12-24 12:38:02 +08:00
update docs
This commit is contained in:
15
README.md
15
README.md
@@ -1,29 +1,28 @@
|
||||
EventBus
|
||||
======
|
||||
[](https://godoc.org/github.com/asaskevich/EventBus) [](https://coveralls.io/r/asaskevich/EventBus?branch=master) [](https://travis-ci.org/asaskevich/EventBus)
|
||||
|
||||
Package EventBus is the little and lightweight eventbus with async compatibility for GoLang.
|
||||
|
||||
|
||||
Modified so that multiple handlers can Subscribe to the same topic.
|
||||
*Modified so that multiple handlers can Subscribe to the same topic.*
|
||||
|
||||
#### Installation
|
||||
Make sure that Go is installed on your computer.
|
||||
Type the following command in your terminal:
|
||||
|
||||
go get github.com/asaskevich/EventBus
|
||||
go get github.com/gaxunil/EventBus
|
||||
|
||||
After it the package is ready to use.
|
||||
|
||||
#### Import package in your project
|
||||
Add following line in your `*.go` file:
|
||||
```go
|
||||
import "github.com/asaskevich/EventBus"
|
||||
import "github.com/gaxunil/EventBus"
|
||||
```
|
||||
If you unhappy to use long `EventBus`, you can do something like this:
|
||||
```go
|
||||
import (
|
||||
evbus "github.com/asaskevich/EventBus"
|
||||
evbus "github.com/gaxunil/EventBus"
|
||||
)
|
||||
```
|
||||
|
||||
@@ -122,13 +121,13 @@ SubscribeOnceAsync works like SubscribeOnce except the callback to executed asyn
|
||||
WaitAsync waits for all async callbacks to complete.
|
||||
|
||||
#### Notes
|
||||
Documentation is available here: [godoc.org](https://godoc.org/github.com/asaskevich/EventBus).
|
||||
Full information about code coverage is also available here: [EventBus on gocover.io](http://gocover.io/github.com/asaskevich/EventBus).
|
||||
Documentation is available here: [godoc.org](https://godoc.org/github.com/gaxunil/EventBus).
|
||||
Full information about code coverage is also available here: [EventBus on gocover.io](http://gocover.io/github.com/gaxunil/EventBus).
|
||||
|
||||
#### Support
|
||||
If you do have a contribution for the package feel free to put up a Pull Request or open Issue.
|
||||
|
||||
#### Special thanks to [contributors](https://github.com/asaskevich/EventBus/graphs/contributors)
|
||||
#### Special thanks to [contributors](https://github.com/gaxunil/EventBus/graphs/contributors)
|
||||
* [Brian Downs](https://github.com/briandowns)
|
||||
* [Dominik Schulz](https://github.com/gittex)
|
||||
* [bennAH](https://github.com/bennAH)
|
||||
|
||||
Reference in New Issue
Block a user