README clean up #282
Merged
README clean up #282
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
Contributor
rpkamp
commented
Nov 29, 2019
rpkamp
commented
| Q | A |
|---|---|
| Bug fix | no |
| New feature | no |
| BC breaks | no |
| Deprecations | no |
| Tests pass | N/A |
| Fixed tickets | - |
| License | MIT |
The requirements as they were might suggest that people need to install guzzle manually, but that's not the case. So that was removed from the requirements, and requirements was renamed to prerequisites, as that sounds less harsh and is used more often in this kind of context.
Describe installation with Symfony Flex as default, but also offer ways to help projects that do not use Symfony Flex. Also stop recommending people to use dev-master, that should really not be done unless you really know what you're doing. And people who know what they're doing don't need documentation on how to require dev-master.
How to use the bundle is different from how to configure it. Configuration deserves its own section for discoverability.
The MockHandler is an advanced topic that should be discussed on its own. Also, having it in the configuration example that people may copy/paste is really not practical because they will have a client that doesn't actually do anything, which is confusing to people who don't know what a MockHandler is. Lastly, to use the MockHandler effectively, one should be able to prime it before it is added to a Client, but that is not possible using this bundle, so let's not recommend doing that at all.
Getting public services from the DI container has been discouraged by Symfony for a while now, let's not show people how it's done, but show them the recommended Symfony way instead, also providing a link for those who prefer autowiring over manual wiring.
Also replace XML with YAML, which is used in the rest of the README as well
gregurco
reviewed
Nov 29, 2019
gregurco
reviewed
Nov 29, 2019
gregurco
reviewed
Nov 29, 2019
gregurco
reviewed
Dec 2, 2019
florianpreusner
approved these changes
Dec 3, 2019
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.