Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] add Build and test locally section #129

Merged
merged 3 commits into from
Sep 8, 2024
Merged

[docs] add Build and test locally section #129

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4c3b4eb
add `Build and test locally` section
yotamloe Sep 8, 2024
2b61c00
Update README.md
yotamloe Sep 8, 2024
d09996a
Update README.md
yotamloe Sep 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions README.md
View file
Open in desktop
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
Loading