Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve the README and LICENSE #4

Merged
merged 1 commit into from Oct 6, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
21 changes: 21 additions & 0 deletions LICENSE
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2019 Vinicius Moraes

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
57 changes: 57 additions & 0 deletions README.md
Expand Up @@ -4,3 +4,60 @@
[![Codecov branch](https://img.shields.io/codecov/c/github/vsmoraes/go-commandbus/master.svg?style=flat-square)](https://codecov.io/gh/vsmoraes/go-commandbus)
[![GoDoc](https://img.shields.io/badge/godoc-reference-5272B4.svg?style=flat-square)](https://godoc.org/github.com/vsmoraes/go-commandbus)
[![Go Report Card](https://goreportcard.com/badge/github.com/vsmoraes/go-commandbus?style=flat-square)](https://goreportcard.com/report/github.com/vsmoraes/go-commandbus)
[![License](https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square)](https://github.com/vsmoraes/go-commandbus/blob/master/LICENSE)

A slight and pluggable command-bus for Go.

## Install

Use go get.
```sh
$ go get github.com/vsmoraes/go-commandbus
```

Then import the package into your own code:
```
import "github.com/vsmoraes/go-commandbus"
```

## Usage
```go
package main

import (
"context"
"log"

"github.com/vsmoraes/go-commandbus"
)

type CreateUser struct {
Name string
}

func CreateHandler(ctx context.Context, cmd *CreateUser) error {
log.Printf("user %s created", cmd.Name)

return nil
}

func main() {
bus := commandbus.New()

err := bus.Register(&CreateUser{}, CreateHandler)

if err != nil {
log.Fatal(err)
}

err = bus.Execute(context.Background(), &CreateUser{"go-commandbus"})

if err != nil {
log.Fatal(err)
}
}
```

## License

This project is released under the MIT licence. See [LICENSE](https://github.com/vsmoraes/go-commandbus/blob/master/LICENSE) for more details.