docs(readme): replace Bun-only instructions with npm#17
Merged
nicomiguelino merged 3 commits intomainfrom May 2, 2026
Merged
Conversation
- Remove Bun-required callout; package now works with npm and Node.js - Add npm as primary installation method, Bun as alternative - Replace bun link/unlink with npm link/unlink in local dev setup - Replace bun run commands with npm run equivalents - Fix components doc link from master to main branch
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the project README to reflect that @screenly/edge-apps can be installed and used primarily with npm/Node.js (with Bun as an alternative), aligning the docs with the current package/tooling.
Changes:
- Replace Bun-only installation/setup instructions with npm-first equivalents.
- Update CLI usage examples to use
npm run ...commands. - Fix the components documentation link to reference
maininstead ofmaster.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…version - Add Node.js >= 20.6.0 requirement note near installation - Add npm install and npm run build steps before npm link - Replace npm unlink with npm install to restore registry version
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
buncommands withnpmequivalents throughoutmastertomain