From bb961763154fac176047474ad8b942765ae3bb55 Mon Sep 17 00:00:00 2001 From: Cracker Date: Fri, 9 Feb 2018 00:12:29 +0100 Subject: [PATCH 1/5] Update README.md --- README.md | 32 +++++++++++++++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9438c37..7c11216 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,32 @@ # whiteboard -Collaborative Whiteboard / Sketchboard +This is a lightweight collaborative Whiteboard witch can easily be customized... + +![start](./doc/start.png) + +## Some Features +* Showing remote user cursors while drawing +* Undo function for each user +* Drag & Drop Images to Whiteboard from PC and Browsers +* Copy & Paste Images from Clipboard +* Resize, Move & Draw Images to Canvas or Background +* 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) + +## Install the App +You can run this app with and without docker +### Without Docker +1. install the latest NodeJs +2. Clone the app +3. Run `npm i` inside the folder +4. Run `node server.js` +5. Surf to http://YOURIP:8080 + +### With Docker +1. `docker run -d -p 8080:8080 rofl256/whiteboard` +2. Surf to http://YOURIP:8080 + +## Things you may want to know +* 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 without ever toutching the whiteboard.js (take a look at index.html & main.js) From f7ad18783784717ff829650ac07318b58e720797 Mon Sep 17 00:00:00 2001 From: Cracker Date: Fri, 9 Feb 2018 00:12:58 +0100 Subject: [PATCH 2/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7c11216..947e9a0 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # whiteboard -This is a lightweight collaborative Whiteboard witch can easily be customized... +This is a lightweight NodeJS collaborative Whiteboard witch can easily be customized... ![start](./doc/start.png) From 334ed34f0d58234aef816cf99757b0356b0ab8ab Mon Sep 17 00:00:00 2001 From: Cracker Date: Fri, 9 Feb 2018 00:16:52 +0100 Subject: [PATCH 3/5] Update README.md --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 947e9a0..8429503 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,15 @@ You can run this app with and without docker 1. `docker run -d -p 8080:8080 rofl256/whiteboard` 2. Surf to http://YOURIP:8080 +## API +Call your site with GET parameters to change the WhiteboardID or the Username + +`http://YOURIP:8080?whiteboardid=MYID&username=MYNAME` + +* whiteboardid => All people with the same ID are drawing on the same board +* username => The name witch is showing to others while drawing + + ## Things you may want to know * 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 From bfc9f4d1e7085c3273c0465f9a40acb337581960 Mon Sep 17 00:00:00 2001 From: Cracker Date: Fri, 9 Feb 2018 00:17:43 +0100 Subject: [PATCH 4/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8429503..8619d5a 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # whiteboard This is a lightweight NodeJS collaborative Whiteboard witch can easily be customized... -![start](./doc/start.png) +![start](https://raw.githubusercontent.com/cracker0dks/whiteboard/master/doc/start.png) ## Some Features * Showing remote user cursors while drawing From b51ff63d5d3af8cf8c620aa6e7acef8695536a3f Mon Sep 17 00:00:00 2001 From: Cracker Date: Fri, 9 Feb 2018 00:19:44 +0100 Subject: [PATCH 5/5] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 8619d5a..716a1cd 100644 --- a/README.md +++ b/README.md @@ -39,3 +39,5 @@ Call your site with GET parameters to change the WhiteboardID or the Username * 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 without ever toutching the whiteboard.js (take a look at index.html & main.js) + +___ MIT License ___