docs: expand README with setup instructions and usage guide - #400
Merged
Conversation
Rewrite the README to address the app developer installing the package, with install / Babel / build steps, a small usage example, a troubleshooting note on manual linking and links to the repo docs. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_016Q3jxdXYUp57UpWMvPZHQD
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
1 participant
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
Significantly expanded the README with comprehensive setup instructions, usage examples, troubleshooting guidance, and links to detailed documentation. This makes the package more accessible to new users by providing clear step-by-step instructions for installation and configuration.
Changes
linkcommand for debugging addon loading issuesNotable Details
The expanded documentation maintains the existing warning about the library being under active development while adding important context about Hermes dependency and platform support limitations. The setup instructions are now concrete and actionable, with code examples and clear explanations of each step's purpose.
https://claude.ai/code/session_016Q3jxdXYUp57UpWMvPZHQD