From 0cc9cdb3d9dcd18ed06dbaaf3da4e604f49c8213 Mon Sep 17 00:00:00 2001
From: Eduard Kuzmenko <thanwords24@gmail.com>
Date: Sat, 17 Apr 2021 02:14:56 +0700
Subject: [PATCH] Update README.md

Added build & debug instructions
---
 README.md | 41 +++++++++++++++++++++++++++++++++++++----
 1 file changed, 37 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 068b17fe..366dceba 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,26 @@
-# Telegram Web K
+## Telegram Web K
+Based on Webogram, patched and improved. Available for everyone here: https://webk.telegram.org/
 
-Based on Webogram, patched and improved.
 
-## Dependencies
+### Developing
+Install dependencies with:
+```lang=bash
+npm install
+```
+This will install all the needed dependencies.
+
+
+#### Running web-server
+Just run `npm start` to start the web server and the livereload task.
+Open http://localhost:8080/ in your browser.
+
+
+#### Running in production
+
+Run `npm run build` to build the minimized production version of the app. Copy `public` folder contents to your web server.
+
+
+### Dependencies
 * [leemon](https://github.com/zerobias/leemon) ([MIT License](https://github.com/zerobias/leemon/blob/master/LICENSE))
 * [pako](https://github.com/nodeca/pako) ([MIT License](https://github.com/nodeca/pako/blob/master/LICENSE))
 * [cryptography](https://github.com/spalt08/cryptography) ([Apache License 2.0](https://github.com/spalt08/cryptography/blob/master/LICENSE))
@@ -13,6 +31,21 @@ Based on Webogram, patched and improved.
 * [libwebp.js](https://libwebpjs.appspot.com/)
 * fastBlur
 
-## Troubleshooting
+### Debugging
+You are welcome in helping to minimize the impact of bugs. There are classes, binded to global context. Look through the code for certain one and just get it by its name in developer tools.
+Source maps are included in production build for your convenience.
+
+#### Additional query parameters
+* **test=1**: to use test DCs
+* **debug=1**: to use debug wherever it tests the flag
+
+Should be applied like that: http://localhost:8080/?test=1
+
+
+### Troubleshooting
 
 If you find an issue with this app, let Telegram know using the [Suggestions Platform](https://bugs.telegram.org/c/4002).
+
+### Licensing
+
+The source code is licensed under GPL v3. License is available [here](/LICENSE).