docs: add installation instructions for local development#2
Merged
Conversation
Add Installation section to README with git clone and local install steps since the package is not yet published to npm. Co-authored-by: Kiro Agent <244629292+kiro-agent@users.noreply.github.com>
Switch from fragile relative path install to npm link, which is the idiomatic approach for local package development. Also clarify that constructs is a required peer dependency. Co-authored-by: Kiro Agent <244629292+kiro-agent@users.noreply.github.com>
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
Add an Installation section to the README with instructions for installing from source, since the package is not yet published to npm.
Changes
npm linkworkflow for local development (idiomatic approach)constructsis a required peer dependencyVerification