This repository has been archived by the owner on Oct 19, 2024. It is now read-only.
Update README to document common feature flags for providers (websock… #1493
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
…ets, ipc and https)
mattsse
suggested changes
Jul 21, 2022
README.md
Outdated
Comment on lines
125
to
131
| If you are looking to connect to a HTTPS endpoint, then you need to enable TLS (`rustls`) and/or SSL (`openssl`) | ||
| feature-flags. | ||
|
|
||
| ```toml | ||
| [dependencies] | ||
|
|
||
| ethers = { git = "https://github.com/gakonst/ethers-rs", features = ["openssl", "rustls"] } |
There was a problem hiding this comment.
I would rather recommend either-or. Enabling both doesn't make much sense.
so let's simply add two toml examples for openssl and rustls
Co-authored-by: Matthias Seitz <matthias.seitz@outlook.de>
gakonst
approved these changes
Jul 24, 2022
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
…ets, ipc and https)
Motivation
Address issue #1261. Including additional information for ipc.
Solution
Update the README with a Providers section detailing the common feature flags.
PR Checklist
I didn't update the changelog as there wasn't a good place to include this and I wasn't sure (given the existing entries) if a global section wanted to be included.