From f0ca174ada81a0ec4b1bbff9b70fcc680e4ca0ad Mon Sep 17 00:00:00 2001
From: Elizabeth Hunt <elizabeth.hunt@simponic.xyz>
Date: Mon, 29 May 2023 14:48:50 -0700
Subject: squash everything since there was profanity in the commit log and
 maybe people won't like that

---
 README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

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.
+```
-- 
cgit v1.2.3-70-g09d2