From 2a6076e5f5461864f8f8a0477a76788959f4d8c5 Mon Sep 17 00:00:00 2001 From: Askill Date: Sun, 11 Sep 2022 16:31:43 +0200 Subject: [PATCH] docs --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 80acfce..57eecef 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,23 @@ # r_place -r/place clone +A go based r/place clone. + +The server has 3 endpoints, get, set and getAll: + +- get: + - websocket connection + - returns once a second all changes as individual events +- set: + - websocket connection + - expects data in the following format: + + x: int [0 - 1000] + y: int [0 - 1000] + color: int [0-15] + timestamp: int [unix time] + userid: int +- getAll: + - returns a jpeg image of current state + +Example Image, created by python client: + +![](images/getAll.png)