Skip to content

Commit

Permalink
[docs] add Build and test locally section (#129)
Browse files Browse the repository at this point in the history
* add `Build and test locally` section

* Update README.md

* Update README.md
  • Loading branch information
yotamloe authored Sep 8, 2024
1 parent e3b6f30 commit 426c624
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand Down Expand Up @@ -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

0 comments on commit 426c624

Please sign in to comment.