This repository has been archived by the owner on Apr 20, 2023. It is now read-only.
README: More consistent formatting with other Go packages. #68
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
Remove the redundant "A Transport for Go's http.Client that will cache responses according to the HTTP RFC" sentence. The next paragraph says something similar. This sentence can already be found in the repository description (one liner). It's very common to find a godoc.org link in the form of a badge in most Go package repository READMEs. Therefore, it's more recognizable and easier to click the link. I think we should use the badge to be friendlier to users, and remove the superseded plain text link. Move License note into its own section at the bottom. This is a more common location. GitHub already detects and displays the license prominently in top right corner, and there is a LICENSE file in the repo, so it makes sense to place Cache Backends section higher up.
|
You can preview what it looks like at https://github.com/gregjones/httpcache/tree/README-adjust-formatting. |
gregjones
reviewed
Apr 24, 2017
README.md
Outdated
| License | ||
| ------- | ||
|
|
||
| - [MIT License](LICENSE) |
There was a problem hiding this comment.
This should be LICENSE.txt, no?
There was a problem hiding this comment.
You're right, thanks for catching this, will fix.
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.
Remove the redundant
A Transport for Go's http.Client that will cache responses according to the HTTP RFCsentence. The next paragraph says something similar. This sentence can already be found in the repository description (one liner):It's very common to find a godoc.org link in the form of a badge in most Go package repository READMEs. Therefore, it's more recognizable and easier to click the link. I think we should use the badge to be friendlier to users, and remove the superseded plain text link.
Move License note into its own section at the bottom. This is a more common location. GitHub already detects and displays the license prominently in top right corner, and there is a LICENSE file in the repo, so it makes sense to place Cache Backends section higher up:
This PR is just a suggestion, feedback is welcome @gregjones.