update README
This commit is contained in:
parent
4e76f40aea
commit
01aa08b2b1
14
README.md
14
README.md
|
@ -4,12 +4,11 @@ This is a lightweight NodeJS collaborative Whiteboard/Sketchboard witch can easi
|
||||||
![start](https://raw.githubusercontent.com/cracker0dks/whiteboard/master/doc/start.png)
|
![start](https://raw.githubusercontent.com/cracker0dks/whiteboard/master/doc/start.png)
|
||||||
|
|
||||||
## Some Features
|
## Some Features
|
||||||
* Showing remote user cursors while drawing
|
* Shows remote user cursors while drawing
|
||||||
* Undo function for each user (strg+z as well)
|
* Undo function for each user (strg+z)
|
||||||
* Drag & Drop Images to Whiteboard from PC and Browsers
|
* Drag+Drop / Copy+Paste Images to Whiteboard from PC and Browsers
|
||||||
* Copy & Paste Images from Clipboard to the Whiteboard
|
|
||||||
* Write text
|
|
||||||
* Resize, Move & Draw Images to Canvas or Background
|
* Resize, Move & Draw Images to Canvas or Background
|
||||||
|
* Write text
|
||||||
* Save Whiteboard to Image and JSON
|
* Save Whiteboard to Image and JSON
|
||||||
* Draw angle lines by pressing "shift" while drawing (with line tool)
|
* Draw angle lines by pressing "shift" while drawing (with line tool)
|
||||||
* Draw square by pressing "shift" while drawing (with rectangle tool)
|
* Draw square by pressing "shift" while drawing (with rectangle tool)
|
||||||
|
@ -21,7 +20,7 @@ You can run this app with and without docker
|
||||||
1. install the latest NodeJs
|
1. install the latest NodeJs
|
||||||
2. Clone the app
|
2. Clone the app
|
||||||
3. Run `npm i` inside the folder
|
3. Run `npm i` inside the folder
|
||||||
4. Run `npm start`
|
4. Run `node server.js`
|
||||||
5. Surf to http://YOURIP:8080
|
5. Surf to http://YOURIP:8080
|
||||||
|
|
||||||
### With Docker
|
### With Docker
|
||||||
|
@ -39,8 +38,7 @@ Call your site with GET parameters to change the WhiteboardID or the Username
|
||||||
|
|
||||||
## Things you may want to know
|
## Things you may want to know
|
||||||
* Whiteboards are gone if you restart the Server, so keep that in mind (or save your whiteboard)
|
* Whiteboards are gone if you restart the Server, so keep that in mind (or save your whiteboard)
|
||||||
* This is just a sample layout to show the functions available
|
* You shoud be able to customize the layout without ever toutching the whiteboard.js (take a look at index.html & main.js)
|
||||||
* You shoud be able to customize without ever toutching the whiteboard.js (take a look at index.html & main.js)
|
|
||||||
|
|
||||||
## ToDo
|
## ToDo
|
||||||
* Make undo function more reliable on texts
|
* Make undo function more reliable on texts
|
||||||
|
|
Loading…
Reference in New Issue