From 426c6241792b8f5af3c8ba69e9cefedad2be09b6 Mon Sep 17 00:00:00 2001
From: Yotam loewenbach <48534558+yotamloe@users.noreply.github.com>
Date: Sun, 8 Sep 2024 16:36:33 +0300
Subject: [PATCH] [docs] add `Build and test locally` section (#129)

* add `Build and test locally` section

* Update README.md

* Update README.md
---
 README.md | 15 +++++++++++----
 1 file changed, 11 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 4f9ad4b..0166008 100644
--- a/README.md
+++ b/README.md
@@ -59,6 +59,17 @@ A few notes are worth mentioning regarding the use of the UDP protocol:
   * UDP can't take advantage of the bulk API, so performance is sub-optimal.
 * When using UDP, each message is sent separately, and not using the bulk API. This means that the meaning of `bufferSize` is slightly different in this case. The messages will still be sent separately, but the logger will wait for the buffer to reach the size specified before sending out all the messages. If you want each message to be sent out immediately, then set `bufferSize = 1`.
 
+## Build and test locally
+1. Clone the repository:
+  ```bash
+  git clone https://github.com/logzio/logzio-nodejs.git
+  cd logzio-nodejs
+  ```
+2. Build and run tests:
+  ```bash
+  npm install
+  npm test
+  ```
 
 ## Update log
 **2.1.8**
@@ -166,7 +177,3 @@ A few notes are worth mentioning regarding the use of the UDP protocol:
 
 </details>
 
-# Scripts
-
-- run `npm install` to install required dependencies
-- run `npm test` to run unit tests