Skip to content

Commit

Permalink
Add ReadMe
Browse files Browse the repository at this point in the history
  • Loading branch information
MilesBreslin committed Jul 5, 2019
1 parent 15f24c1 commit 13864e2
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Rocket Bot Go

This is an API for a Rocket Chat bot written in go. The library for this rocket bot is in the `rocket` folder. `main.go` is a demo implementation of a chat bot.

#### Building Demo

Before building the demo, ensure that the _go_ compiler is installed and that both the _yaml_ and _websocket_ libraries are installed. Then use the _go_ compiler to build the executable. Assuming the _go_ compiler is installed, these 3 commands will compile the demo.

```
go get gopkg.in/yaml.v2
go get github.com/gorilla/websocket
go build main.go
```

#### Using as a library

To use the library for the rocket bot, add as an import `github.com/MilesBreslin/rocket-bot-go/rocket` and ensure that it has been added to your go source path (`${GOPATH:-~/go}/src`) by running the following:
```
go get github.com/MilesBreslin/rocket-bot-go/rocket
```

#### License

This project is licensed under the MIT License. See the `LICENSE` file for more details.

0 comments on commit 13864e2

Please sign in to comment.