docs: point Electron users to @bugsplat/electron and its example - #20
Open
bobbyg603 wants to merge 1 commit into
Open
docs: point Electron users to @bugsplat/electron and its example#20bobbyg603 wants to merge 1 commit into
bobbyg603 wants to merge 1 commit into
Conversation
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01KoWGNtyTyAq184QWQ2aquX
There was a problem hiding this comment.
Pull request overview
Updates the repository README to steer Electron developers toward the dedicated @bugsplat/electron package and its maintained example, keeping this Node-focused SDK documentation current as older Electron sample repos are being archived.
Changes:
- Clarifies that
bugsplat-nodetargets Node.js, and points Electron users to@bugsplat/electronwith a brief capability summary (init()for native + JS errors). - Replaces the
my-electron-crashersample link with thebugsplat-electronrepository’sexample/directory link.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| ## 👋 Introduction | ||
|
|
||
| BugSplat-node is a JavaScript error reporting system for Node.js and Electron applications. Before continuing with the tutorial please make sure you have completed the following checklist: | ||
| BugSplat-node is a JavaScript error reporting system for Node.js applications. For Electron apps, use [@bugsplat/electron](https://github.com/BugSplat-Git/bugsplat-electron), which wires native crash reporting and JavaScript errors from a single `init()`. Before continuing with the tutorial please make sure you have completed the following checklist: |
| * [Sign Up](https://app.bugsplat.com/v2/sign-up) as a new BugSplat user | ||
| * Complete the [Welcome](https://app.bugsplat.com/v2/welcome) workflow and make a note of your BugSplat database | ||
| * Review our [my-node-crasher](https://github.com/BugSplat-Git/my-node-crasher) or [my-electron-crasher](https://github.com/BugSplat-Git/my-electron-crasher) projects to see a sample Node.js project integrated with BugSplat | ||
| * Review our [my-node-crasher](https://github.com/BugSplat-Git/my-node-crasher) or [bugsplat-electron example](https://github.com/BugSplat-Git/bugsplat-electron/tree/main/example) projects to see a sample Node.js project integrated with BugSplat |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
README only: Electron users are pointed to
@bugsplat/electron(a singleinit()for native crashes + JavaScript errors), and the sample link now targets itsexample/directory becausemy-electron-crasheris being archived.🤖 Generated with Claude Code
https://claude.ai/code/session_01KoWGNtyTyAq184QWQ2aquX