docs: make the install instructions work - #6
Merged
Conversation
The advertised install commands pointed at registries that 404 — the SDKs are not published to npm, PyPI or crates.io. Since every SDK repository is public, installing from git works today, so these are real commands rather than aspirational ones, with a note that registry packages are not yet published. Co-Authored-By: Claude Fable 5 <[email protected]>
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.
Every install command in this README pointed at a package registry that returns 404. Willow’s SDKs are not published to npm, PyPI or crates.io, so anyone following the quick-start hit a dead end on the first command.
All the SDK repositories are public, so an install from git works today. This replaces each false command with one that actually resolves, and adds a short note explaining that the packages are not on registries yet.
No code changes; README only.