| 1 | # libhoney [](https://circleci.com/gh/honeycombio/libhoney-js) [](https://badge.fury.io/js/libhoney)
|
| 2 |
|
| 3 | A Node.js module for sending events to [Honeycomb](https://www.honeycomb.io), a service for debugging your software in production.
|
| 4 |
|
| 5 | **NOTE** For use in browser-side JavaScript applications, generate an API key that has permission only to send events.
|
| 6 |
|
| 7 | Requires any current LTS release of Node.js. Currently v8, and >= v10.
|
| 8 |
|
| 9 | - [Usage and Examples](https://docs.honeycomb.io/sdk/javascript/)
|
| 10 | - [API Reference](https://doc.esdoc.org/github.com/honeycombio/libhoney-js/)
|
| 11 |
|
| 12 | For tracing support and automatic instrumentation of Express and other common libraries, check out our [Beeline for NodeJS](https://github.com/honeycombio/beeline-nodejs).
|
| 13 |
|
| 14 | ## Contributions
|
| 15 |
|
| 16 | Features, bug fixes and other changes to libhoney are gladly accepted. Please
|
| 17 | open issues or a pull request with your change. Remember to add your name to the
|
| 18 | CONTRIBUTORS file!
|
| 19 |
|
| 20 | All contributions will be released under the Apache License 2.0.
|
| 21 |
|
| 22 | ### Releasing a new version
|
| 23 |
|
| 24 | Travis will automatically upload tagged releases to NPM.
|