From 37cef6e4647c9adf02a9af021348499f2e10939e Mon Sep 17 00:00:00 2001
From: daniel muniz <munidaniel@gmail.com>
Date: Thu, 13 Jun 2024 09:45:23 -0300
Subject: [PATCH] implementing incompass sdk in readme

---
 README.md | 42 +++++++++++++++++++++++++++++++++++-------
 1 file changed, 35 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 9946037..3cbedd4 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,41 @@
-# netstar-categorizer
-# UDP Server
+# UDP Server - netstar-categorizer
 
-This project is a UDP server built with Node.js that processes incoming messages and returns categorized results.
+This project is a UDP server built with Node.js that processes incoming messages and returns categorized NetStar results in Zvelo pattern.
 
 ## Prerequisites
 
 - Node.js (v12.x or higher recommended)
 - npm (v6.x or higher recommended)
+- NetStar inCompass SDK
 
-## Setup
+## InCompass SDK Setup
+
+1. The inCompass SDK requires Boost C++ Libraries. To install the libraries, run:
+
+```
+apt-get install libboost-all-dev
+```
+
+2. To install the inCompass SDK, run:
+
+```
+dpkg -i gcf1-global_{SDK Version}_deb{Debian Version}-amd64.deb
+```
+
+3. To daemonize the service, run:
+
+```
+cp -p /usr/local/gcf1/sbin/gcf1 /etc/init.d/
+insserv gcf1
+```
+
+4. Or, depending on the Debian version, run:
+
+```
+ systemctl enable gcf1
+```
+
+## UDP Server Setup
 
 1. Clone the repository:
 
@@ -34,6 +61,7 @@ This project is a UDP server built with Node.js that processes incoming messages
 
 To start the UDP server, use the following command:
 
-```
-npm start
-```
\ No newline at end of file
+  ```
+  npm start
+  ```
+  This will run the server and bind it to the port specified in your .env file.