diff --git a/README.md b/README.md index a4e2eee..9946037 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,39 @@ # netstar-categorizer -This tool install, download and convert categories for zvelo patterns +# UDP Server + +This project is a UDP server built with Node.js that processes incoming messages and returns categorized results. + +## Prerequisites + +- Node.js (v12.x or higher recommended) +- npm (v6.x or higher recommended) + +## Setup + +1. Clone the repository: + + ```bash + git clone + cd + ``` + +2. Install the dependencies: + + ```bash + npm install + ``` + +3. Create a .env file in the root of the project and add your environment variables. At a minimum, you should specify the PORT: + + ``` + cp .env.example .env + PORT=3000 + ``` + +## Running the Server + +To start the UDP server, use the following command: + +``` +npm start +``` \ No newline at end of file