docs: fix lighthouse-sdk installation command - use cargo add instead of cargo install #65
Conversation
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.
Problem
The current documentation shows an incorrect installation command for the Rust SDK:
This command fails because lighthouse-sdk v2.0.0 is a library crate, not a binary program.
Solution
Updated the documentation to use the correct command:
Before (Current Docs):
Error when following current docs:
The error clearly states: there is nothing to install in 'lighthouse-sdk v2.0.0', because it has no binaries. 'cargo install' is only for installing programs, and can't be used with libraries.
fix:
Impact
This fix will prevent confusion for new developers trying to integrate Lighthouse into their Rust projects and reduce support requests about installation issues.