Clarify installation instructions for alloy #697
Merged
Conversation
This file contains 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
saefstroem
requested review from
DaniPopes,
gakonst,
mattsse,
onbjerg,
prestwich and
Evalir
as code owners
prestwich
approved these changes
May 6, 2024
ben186
pushed a commit
to ben186/alloy
that referenced
this pull request
Jul 27, 2024
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.
Motivation
When I stumbled upon this repository after seeing that ethers-rs was being deprecated I struggled for a couple of hours trying to understand why my installation was failing when doing
cargo install. Had it been clear in the repo documentation that the crates are not available on the Rust package repository I would have saved myself some time.In the telegram chat I also received a pastebin link for all the different features that are available in the crate. Personally, I think that sharing pastebin links is not a good practice given that they can be used by malicious actors to spread malware etc. Therefore it is better to clearly state this in the main repo for clarity purposes.
Solution
I added a section explaining that the repo is currently not available on crates.io and how a developer can add it to their project as well as a permalink to the different exported features by the crate.
PR Checklist