Add README

This commit is contained in:
Trevor Slocum 2023-08-26 20:43:23 -07:00
parent 4c534c3fa3
commit eb32d1cae1
2 changed files with 12 additions and 2 deletions

View file

@ -83,8 +83,8 @@ Data types:
- `line` - alphanumeric with spaces
All events are sent in either JSON or human-readable format. The human-readable
format is documented here. The structure of each JSON message is available by referencing
[this file](https://code.rocket9labs.com/tslocum/bgammon/src/branch/main/event.go).
format is documented here. The structure of each JSON message is available via
[godoc](https://docs.rocket9labs.com/code.rocket9labs.com/tslocum/bgammon/#Event).
### `hello <message:line>`

10
README.md Normal file
View file

@ -0,0 +1,10 @@
# bgammon - Online backgammon server and client interface
[![GoDoc](https://code.rocket9labs.com/tslocum/godoc-static/raw/branch/master/badge.svg)](https://docs.rocket9labs.com/code.rocket9labs.com/tslocum/bgammon)
[![Donate via LiberaPay](https://img.shields.io/liberapay/receives/rocket9labs.com.svg?logo=liberapay)](https://liberapay.com/rocket9labs.com)
[![Donate via Patreon](https://img.shields.io/badge/dynamic/json?color=%23e85b46&label=Patreon&query=data.attributes.patron_count&suffix=%20patrons&url=https%3A%2F%2Fwww.patreon.com%2Fapi%2Fcampaigns%2F5252223)](https://www.patreon.com/rocketnine)
## Support
Please share issues and suggestions [here](https://code.rocket9labs.com/tslocum/bgammon/issues).
The bgammon protocol specification is in [PROTOCOL.md](https://code.rocket9labs.com/tslocum/bgammon/src/branch/main/PROTOCOL.md).