summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README8
1 files changed, 8 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..a66e630
--- /dev/null
+++ b/README
@@ -0,0 +1,8 @@
+Wordle-Backend
+
+endpoint /create
+* create a new puzzle (stored in a cookie)
+
+endpoint /try/$your_trial
+* retrieve statistics on the trial word $your_trial in json
+* this will redirect to create a new puzzle if no cookie is found