From fc5d0d102d3d1086d13a8818ec676c612b8fee05 Mon Sep 17 00:00:00 2001
From: Dzejkobik007 <kuba.rybnicek@gmail.com>
Date: Tue, 6 Jun 2023 23:43:06 +0200
Subject: [PATCH] Updated README.md

---
 README.md | 31 +++++++++++++++++++++++++++++--
 1 file changed, 29 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 2d9c7d3..bd2cfa6 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,32 @@
 # Kakubovna
 
-A simple file sharing platform
+A "simple" file sharing platform
 
-# NOT FINISHED, i am doing my best
\ No newline at end of file
+# NOT FINISHED, i am doing my best
+
+# Quick start
+## Docker
+```bash
+git clone https://github.com/Dzejkobik007/skolavdf.git
+cd Kakubovna/docker
+docker-compose up -d --build
+```
+## Manual
+```bash
+# Install required tools with your system package manager
+sudo apt install git node npm
+
+git clone https://github.com/Dzejkobik007/skolavdf.git
+cd Kakubovna/app
+npm install --production
+nodejs app.js
+```
+
+
+## Dependencies
+
+- [express](https://github.com/expressjs/express)
+- [socket.io](https://github.com/socketio/socket.io)
+- [socketio-file-upload](https://github.com/sffc/socketio-file-upload)
+- [better-sqlite3](https://github.com/socketio/socket.io)
+- [loglevel](https://github.com/pimterry/loglevel)
\ No newline at end of file