raphael/whiteboard
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Cracker 2021-03-03 13:14:37 +01:00 committed by GitHub
parent 89b3c10d95
commit e516a24426
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -109,13 +109,6 @@ Call your site with GET parameters to change the WhiteboardID or the Username
- title => Change the name of the Browser Tab - title => Change the name of the Browser Tab
- randomid => if set to true, a random whiteboardId will be generated if not given aswell - 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 ## Configuration
Many settings of this project can be set using a simple `yaml` file, to change some behaviors or tweak performances. Many settings of this project can be set using a simple `yaml` file, to change some behaviors or tweak performances.
@ -143,6 +136,13 @@ Then set the same token on the client side as well:
Done! Done!
#### 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.
#### WebDAV (Optional) #### WebDAV (Optional)
This function allows your users to save the whiteboard directly to a webdav server (Nextcloud) as image without downloading it. This function allows your users to save the whiteboard directly to a webdav server (Nextcloud) as image without downloading it.