From 89b3c10d950204ed2c2331ebea525f0bf49d7ef5 Mon Sep 17 00:00:00 2001 From: Cracker Date: Wed, 3 Mar 2021 13:12:02 +0100 Subject: [PATCH] Update README.md --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 53895f5..1b147cf 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,7 @@ This is a lightweight NodeJS collaborative Whiteboard/Sketchboard which can easi - Draw square by pressing "Shift" while drawing (with rectangle tool) - Indicator that shows the smallest screen participating - Keybindings for ALL the functions +- REST API - Working on PC, Tablet & Mobile ## Projects using this Whiteboard @@ -108,6 +109,13 @@ Call your site with GET parameters to change the WhiteboardID or the Username - title => Change the name of the Browser Tab - randomid => if set to true, a random whiteboardId will be generated if not given aswell +## REST API + +You can fully control the whiteboard through a REST API. Explore and test the API for your server version by surfing to: `[yourRootWhiteboardUrl]/apidoc/index.html` +You can see the API for the Demowhiteboard here: [DemoAPI](https://cloud13.de/testwhiteboard/apidoc/index.html) + +Note: This API is pretty new, so be sure to use the latest Whiteboard version. + ## Configuration Many settings of this project can be set using a simple `yaml` file, to change some behaviors or tweak performances.