Lead SDK READMEs with package install steps#1
Open
sairin1202 wants to merge 1 commit into
Open
Conversation
Make the package-manager install the primary step in the Python and JavaScript SDK READMEs (pip install / npm install) and demote the curl CLI installer to a secondary "global CLI" option, so SDK consumers see the right first step. Co-authored-by: Cursor <cursoragent@cursor.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
pip install boids-sdkto the primary install step inpython/README.md.npm install boids-sdkto the primary install step injs/README.md(and notenpx boids ...for the bundled CLI).curl ... install.shbash installer to a secondary "install the standalone CLI globally" option in both.Goal: SDK consumers see the package-manager install first instead of the CLI installer.
Test plan
Made with Cursor