Update README

README.md

@@ -1,24 +1,94 @@
+### **Dota 2 React HUD for [LHM.gg](http://LHM.gg)**
 
-<p align="center">
-	<p align="center" style="font-weight:600; letter-spacing:1pt; font-size:20pt;">LEXOGRINE HUD</p>
-	<p align="center"><img src="icon.png" alt="Logo" width="80" height="80"></p>
-	<p align="center" style="font-weight:400;">Powered by <a href='https://github.com/lexogrine/hud-manager'><strong>« Lexogrine HUD Manager »</strong></a></p>
-</p>
+Dota2 React HUD for [LHM.gg](http://LHM.gg), created by Lexogrine, is an open source Dota 2 HUD that you can use and modify to your needs. It’s the core element of building customized Dota 2 HUDs and spectator overlays for the [LHM.gg](http://LHM.gg) platform.
 
-# Lexogrine HUD
+It comes with a set of default options and features that you can use for creating your unique esport experience.
 
-  
+**Preview**  
+![Preview of HUDs pick process](picking.png)
+![Preview of HUDs ingame part](ingame.png)
+![Preview of HUDs ending scoreboard](scoreboard.png)
 
-Fullfledged example of the React HUD made for HUD Manager.
+**Download**  
+To download it, simply click here: [**DOWNLOAD Dota 2 React HUD for LHM.gg**](https://lhm.gg/download?target=dota2)
 
+**Setting up**  
+Fork this repo, clone it, and then run `npm install` and `npm start`. HUD should start on the `3500` port. For this to work, have [LHM.gg](http://LHM.gg) open so it will pass Dota 2 data to the HUD.
 
-## Keybinds & Panel:
-For keybinds & panel API read [csgo-react-hud docs](https://github.com/lexogrine/csgo-react-hud)
+**Building & distributing**  
+To build a version to distribute and move around, in the root directory, run `npm run pack`. It will create the zip file for distribution. Now you can just drag and drop this file into the LHM.gg upload area.
 
-# Download
+##### **Signing**
 
-To download it just click here: [DOWNLOAD HUD](https://github.com/lexogrine/csgo-react-hud/releases/latest)
+To create Signed CS2 HUD for [LHM.gg](http://LHM.gg) to prevent at least from modifying compiled JavaScript files, run `npm run sign`. It's the same as `npm run pack` command but with an additional step of signing `.js` and `.css` files and `hud.json`.
 
-# Note
+**`panel.json` API**  
+To get the incoming data from the HUD Manager, let's take a look at the `src/HUD/SideBoxes/SideBox.tsx` `componentDidMount()` method:
 
-This is early beta of Dota 2 custom HUD. Current release is targeted for developers to gather their feedback.
+```javascript
+import {configs} from  './../../App';
+...
+configs.onChange((data:any) => {
+	if(!data) return;
+
+	const  display = data.display_settings;
+
+	if(!display) return;
+
+	if(display[`${this.props.side}_title`]){
+		this.setState({title:display[`${this.props.side}_title`]})
+	}
+	if(display[`${this.props.side}_subtitle`]){
+		this.setState({subtitle:display[`${this.props.side}_subtitle`]})
+	}
+	if(display[`${this.props.side}_image`]){
+		this.setState({image:display[`${this.props.side}_image`]})
+	}
+});
+```
+
+To retrieve incoming data, you should just import `configs` object and then listen for the changes with `onChange` method. Usually you want to check for the specific data, as in the callback it will always serve the full form from the Manager. However it looks different in the case of action input. In this case, let's look at the `src/HUD/Trivia/Trivia.tsx`:
+
+```javascript
+import {configs, actions} from  './../../App';
+...
+actions.on("triviaState", (state: any) => {
+	this.setState({show:  state === "show"})
+});
+```
+
+For the action input we need to import the `actions` object and create listener with the parameter on it.
+
+## `keybinds.json` API
+
+Keybinds API works in very similiar to `panel.json` action API. One more time the example will be from `src/HUD/Trivia/Trivia.tsx`:
+
+```javascript
+import {configs, actions} from  './../../App';
+...
+actions.on("toggleTrivia", () => {
+	this.setState({show: !this.state.show})
+});
+```
+
+For the action input we need to import the `actions` object and create listener with the parameter on it.
+
+**`keybinds.json` API**  
+Keybinds API works in very similiar to `panel.json` action API. One more time the example will be from `src/HUD/Trivia/Trivia.tsx`:
+
+```javascript
+import {configs, actions} from  './../../App';
+...
+actions.on("toggleTrivia", () => {
+	this.setState({show: !this.state.show})
+});
+```
+
+Keybinds listener works on the same object as action input, in this case however there are no parameter to retrieve.
+
+**About Lexogrine**  
+[Lexogrine](http://lexogrine.com) is an AI software development company, offering top-tier AI, web, and mobile design and development services for international companies. Alongside that, Lexogrine offers a set of web and mobile applications \- including [LHM.gg](http://LHM.gg) \- that revolutionize the way experts and specialists from different industries work together on a daily basis.
+
+[Lexogrine](http://lexogrine.com) specializes in AI development, alongside web, mobile, and cloud development with technologies like TypeScript, Python, LLM, React, React Native, Node.js, Prisma, Medusa, Pytorch, AWS, and Google Cloud Platform.
+
+With over 5 years of experience, Lexogrine delivered hundreds of projects, supporting companies and enterprises from all over the world.

package.json

@@ -1,21 +1,24 @@
 {
   "name": "lexogrine_dota2_hud",
-  "version": "1.0.0",
+  "version": "1.3.1",
   "homepage": "./",
   "private": true,
   "dependencies": {
     "@craco/craco": "^5.7.0",
     "@types/jest": "24.0.19",
-    "@types/node": "12.11.1",
-    "@types/react": "16.9.9",
-    "@types/react-dom": "16.9.2",
-    "dotagsi": "^1.0.7",
+    "@types/node": "18.15.11",
+    "@types/react": "18.0.35",
+    "@types/react-dom": "18.0.11",
+    "buffer": "^6.0.3",
+    "dotagsi": "^1.5.0",
     "query-string": "^6.12.1",
-    "react": "^16.13.1",
-    "react-dom": "^16.13.1",
-    "react-scripts": "4.0.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "react-scripts": "5.0.1",
+    "simple-peer": "^9.11.0",
     "socket.io-client": "^4.1.3",
-    "typescript": "3.6.4"
+    "typescript": "^4.9.5",
+    "uuid": "^8.3.2"
   },
   "license": "GPL-3.0",
   "scripts": {
@@ -24,7 +27,8 @@
     "build": "react-scripts build",
     "test": "react-scripts test",
     "eject": "react-scripts eject",
-    "pack": "npm run build && npm run zip"
+    "pack": "npm run build && npm run zip",
+    "sign": "npm run build && node sign.js && npm-build-zip --name=signed"
   },
   "eslintConfig": {
     "extends": "react-app"
@@ -43,7 +47,11 @@
   },
   "devDependencies": {
     "@types/history": "^4.7.5",
+    "@types/simple-peer": "^9.11.3",
+    "@types/socket.io-client": "^1.4.32",
+    "@types/uuid": "^8.3.3",
     "internal-ip": "^6.2.0",
+    "jsonwebtoken": "^8.5.1",
     "npm-build-zip": "^1.0.2",
     "open": "^8.0.2",
     "sass": "^1.32.5"