update README

This commit is contained in:
raphael 2019-07-01 15:28:11 +02:00
parent 7046e21b47
commit a9be265071

View File

@ -12,6 +12,7 @@ This is a lightweight NodeJS collaborative Whiteboard/Sketchboard witch can easi
* Save Whiteboard to Image and JSON
* Draw angle lines by pressing "shift" while drawing (with line tool)
* Draw square by pressing "shift" while drawing (with rectangle tool)
* Indicator that shows the smallest screen participating
* Working on PC, Tablet & Mobile
## Install the App
@ -25,7 +26,7 @@ You can run this app with and without docker
### With Docker
1. `docker run -d -p 8080:8080 rofl256/whiteboard`
2. Surf to http://YOURIP:8080
2. Surf to http://YOURIP:8080s
## URL Parameters
Call your site with GET parameters to change the WhiteboardID or the Username
@ -70,7 +71,7 @@ Done!
* Whiteboards are gone if you restart the Server, so keep that in mind (or save your whiteboard)
* You shoud be able to customize the layout without ever toutching the whiteboard.js (take a look at index.html & main.js)
## All server run parameters (also docker)
## All server start parameters (also docker)
* accesstoken => take a look at "Security - AccessToken" for a full explanation
* disablesmallestscreen => set this to "true" if you don't want show the "smallest screen" indicator (A dotted gray line) to the users
* webdav => Enable the function to save to a webdav-server (Must also be enabled on the client; Take a look at the webdav section)