| 1 | # libhoney
|
| 2 |
|
| 3 | [](https://github.com/honeycombio/home/blob/main/honeycomb-oss-lifecycle-and-practices.md)
|
| 4 | [](https://circleci.com/gh/honeycombio/libhoney-js)
|
| 5 | [](https://badge.fury.io/js/libhoney)
|
| 6 |
|
| 7 | A Node.js module for sending events to [Honeycomb](https://www.honeycomb.io), a service for debugging your software in production.
|
| 8 | For tracing support and automatic instrumentation of Express and other common libraries, check out our [Beeline for NodeJS](https://github.com/honeycombio/beeline-nodejs).
|
| 9 |
|
| 10 | [Usage and Examples](https://docs.honeycomb.io/getting-data-in/javascript/libhoney/)
|
| 11 |
|
| 12 | **NOTE** For use in browser-side JavaScript applications, generate an API key that has permission only to send events.
|
| 13 |
|
| 14 | ## Dependencies
|
| 15 |
|
| 16 | **Node 14+**
|
| 17 |
|
| 18 | ## Contributions
|
| 19 |
|
| 20 | Features, bug fixes and other changes to libhoney are gladly accepted. Please
|
| 21 | open issues or a pull request with your change.
|
| 22 |
|
| 23 | All contributions will be released under the Apache License 2.0.
|
| 24 |
|
| 25 | ### Releasing a new version
|
| 26 |
|
| 27 | Use `npm version --no-git-tag-version` to update the version number using `major`, `minor`, `patch`, or the prerelease variants `premajor`, `preminor`, or `prepatch`. We use `--no-git-tag-version` to avoid automatically tagging - tagging with the version automatically triggers a CI run that publishes, and we only want to do that upon merging the PR into `main`.
|
| 28 |
|
| 29 | After doing this, follow our usual instructions for the actual process of tagging and releasing the package.
|