Skip to content

Latest commit

 

History

History
52 lines (34 loc) · 1.6 KB

README.md

File metadata and controls

52 lines (34 loc) · 1.6 KB

Honeybadger Client Side Javascript Library

Build Status

A JavaScript library for integrating apps with the ⚡ Honeybadger Rails Error Notifier.

Upgrading

It is recommended that you use our CDN, as outlined under installation. The API is 100% backwards compatible, so no other code changes are required.

Note: 0.1 and 0.2 make significant improvements to error grouping. As a result, new errors may be grouped differently than old.

Installation

Place the following code between the <head></head> tags of your page:

<script src="//js.honeybadger.io/v0.2/honeybadger.min.js" type="text/javascript"></script>
<script type="text/javascript">
  Honeybadger.configure({
    api_key: 'public api key',
    environment: 'production'
  });
</script>

See the documentation for usage examples.

Documentation

View the Documentation

Contributing

  1. Fork it.
  2. Create a topic branch git checkout -b my_branch
  3. Commit your changes git commit -am "Boom"
  4. Push to your branch git push origin my_branch
  5. Send a pull request

Running the tests

To run the test suite, enter make test into the console.

License

The Honeybadger gem is MIT licensed. See the MIT-LICENSE file in this repository for details.