From a653d967fd8aa03d11cb23f6fe29a3f14a730a33 Mon Sep 17 00:00:00 2001
From: joak <joak@xpub.nl>
Date: Sun, 11 Feb 2024 22:53:49 +0100
Subject: [PATCH] infos

---
 README.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)

diff --git a/README.md b/README.md
index 3fbf99f..fc85efe 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,33 @@
 # collective drawing editor
+
+![editor](drawing.png)
+
+this is a collective drawing editor. its like a etherpad but for drawings. current functions:
+* change line cap
+* change color
+* change line width
+it uses [socket.io](https://socket.io/)
+
+### installation
+1. install nodejs 
+    * debian
+> $ sudo apt install node 
+    * os x
+> $ brew install node 
+    * else
+information on the website https://nodejs.org
+2. install npm
+    * debian
+> $ sudo apt install npm 
+    * os x
+> $ brew install npm 
+    * else
+information on the website https://docs.npmjs.com/
+3. clone the repository
+> $ git clone https://git.xpub.nl/joak/colletive-drawing/
+4. change directory
+> $ cd collective-drawing
+4. install the dependecies
+> npm install 
+5. run it
+> $ node index.js
\ No newline at end of file