rocket-bot-go

README

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.

Documentation

Overview

Specify we are the main package (the one that contains the main function)