Skip to content

Commit

Permalink
Make readme clearer about what skip_html_injection
Browse files Browse the repository at this point in the history
The readme says that `skip_html_injection` prevents "XHR" from being injected into the page. That's not really what this option does - it prevents HTML from being injected (and also adds javascript to the page to intercept XHR requests).

I've tweaked the wording so it's clearer that this isn't just about XHR.
  • Loading branch information
iainbeeston authored Feb 24, 2021
1 parent 072b8e5 commit 91e62be
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ The code above will enable all of the Bullet notification systems:
* `Bullet.rollbar`: add notifications to rollbar
* `Bullet.sentry`: add notifications to sentry
* `Bullet.add_footer`: adds the details in the bottom left corner of the page. Double click the footer or use close button to hide footer.
* `Bullet.skip_html_injection`: prevents Bullet from injecting XHR into the returned HTML. This must be false for receiving alerts or console logging.
* `Bullet.skip_html_injection`: prevents Bullet from injecting code into the returned HTML. This must be false for receiving alerts, showing the footer or console logging.
* `Bullet.stacktrace_includes`: include paths with any of these substrings in the stack trace, even if they are not in your main app
* `Bullet.stacktrace_excludes`: ignore paths with any of these substrings in the stack trace, even if they are not in your main app.
Each item can be a string (match substring), a regex, or an array where the first item is a path to match, and the second
Expand Down

0 comments on commit 91e62be

Please sign in to comment.