update docs

This commit is contained in:
John Noble
2015-04-16 14:56:52 -06:00
parent f71cc01216
commit acae292982

View File

@@ -1,29 +1,28 @@
EventBus
======
[![GoDoc](https://godoc.org/github.com/asaskevich/EventBus?status.svg)](https://godoc.org/github.com/asaskevich/EventBus) [![Coverage Status](https://img.shields.io/coveralls/asaskevich/EventBus.svg)](https://coveralls.io/r/asaskevich/EventBus?branch=master) [![Build Status](https://travis-ci.org/asaskevich/EventBus.svg)](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)