diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..e190b31 --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +# example chessh bot + +this is a simple CheSSH bot written in TypeScript using js-chess-engine. it's not very good. + +the bot "entrypoint" is at `/src/api/index.ts`. + +## environment +``` +BOT_TOKEN: the token generated by CheSSH for which the bot will be deployed +CHESSH_MOVE_PATH: the path to POST an attempted move in the form "<from square><to square>" according to the CheSSH contract to the game with id :gameId. +``` |