Merge branch 'master' of https://github.com/cracker0dks/whiteboard

README.md

@@ -4,11 +4,11 @@ This is a lightweight NodeJS collaborative Whiteboard/Sketchboard witch can easi
 ![start](https://raw.githubusercontent.com/cracker0dks/whiteboard/master/doc/start.png)
 
 ## Demowhiteboard ##
-[HERE](https://cloud13.de/testwhiteboard/) (Resets every night)
+[HERE](https://cloud13.de/testwhiteboard/) (Reset every night)
 
 ## Some Features
 * Shows remote user cursors while drawing
-* Undo function for each user (strg+z)
+* Undo function for each user
 * Drag+Drop / Copy+Paste Images to Whiteboard from PC and Browsers
 * Resize, Move & Draw Images to Canvas or Background
 * Write text
@@ -16,6 +16,7 @@ This is a lightweight NodeJS collaborative Whiteboard/Sketchboard witch can easi
 * 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
+* Keybindings for ALL the functions
 * Working on PC, Tablet & Mobile
 
 ## Install the App
@@ -31,6 +32,51 @@ You can run this app with and without docker
 1. `docker run -d -p 8080:8080 rofl256/whiteboard`
 2. Surf to http://YOURIP:8080
 
+## Default keyboard shortcuts
+Use keyboard shortcuts to become more productive while using Whiteboard.
+
+They are especially useful if you work with interactive displays such as XP-Pen Artist, Huion Kamvas and Wacom Cintiq. These devices have quick buttons (6-8 buttons and scrolling). By default, the buttons on these displays are mapped to standard Photoshop keyboard shortcuts. Keys can be configured to function effectively in other software.
+
+The following are predefined shortcuts that you can override in the file [/public/js/keybinds.js](https://github.com/cracker0dks/whiteboard/blob/master/public/js/keybinds.js)
+
+Result | Windows and Linux | macOS
+------ | -------------------- | -------
+Clear the whiteboard | Ctrl + Shift + Z | Command + Shift + Z
+Undo your last step | Ctrl + Z | Command + Z
+Select an area | Ctrl + X | Command + X
+Take the mouse | Ctrl + M | Command + M
+Take the pen | Ctrl + P | Command + P
+Draw a line | Ctrl + L | Command + L
+Draw a rectangle | Ctrl + R | Command + R
+Draw a circle | Ctrl + C | Command + C
+Toggle between line, rectangle and circle | Ctrl + Shift + F | Command + Shift + F
+Toggle between pen and eraser | Ctrl + Shift + X | Command + Shift + X
+Toggle between main clolors (black, blue, green, yellow and red) | Ctrl + Shift + R | Command + Shift + R
+Write text | Ctrl + A | Command + A
+Take the eraser | Ctrl + E | Command + E
+Increase thickness | Ctrl + Up Arrow | Command + Up Arrow
+Decrease thickness | Ctrl + Down Arrow | Command + Down Arrow
+Colorpicker | Ctrl + Shift + C | Command + Shift + C
+Set black color | Ctrl + Shift + 1 | Command + Shift + 1
+Set blue color | Ctrl + Shift + 2 | Command + Shift + 2
+Set green color | Ctrl + Shift + 3 | Command + Shift + 3
+Set yellow color | Ctrl + Shift + 4 | Command + Shift + 4
+Set red color | Ctrl + Shift + 5 | Command + Shift + 5
+Save whiteboard as image | Ctrl + S | Command + S
+Save whiteboard as JSON | Ctrl + Shift + K | Command + Shift + K
+Save whiteboard to WebDav | Ctrl + Shift + I (i) | Command + Shift + I (i)
+Load saved JSON to whiteboard | Ctrl + Shift + J | Command + Shift + J
+Share whiteboard | Ctrl + Shift + S | Command + Shift + S
+Hide or show toolbar | Tab | Tab
+Move selected object up | Up Arrow | Up Arrow
+Move selected object down | Down Arrow | Down Arrow
+Move selected object left | Left Arrow | Left Arrow
+Move selected object right | Right Arrow | Right Arrow
+Drop object | Ctrl + Enter | Command + Enter
+Add Image to backgroud | Shift + Enter | Shift + Enter
+Cancel all actions | Escape | Escape
+Delete selected object | Delete | Delete
+
 ## URL Parameters
 Call your site with GET parameters to change the WhiteboardID or the Username