Repository navigation
Describe README users by category and move the list to the end - #585
Merged
Merged
Conversation
Give each named system its full name and a one-line description. Mark the projects that depend on this Go package.
Keep the categorized user list at the end of the README, and include the Go dependents added on master. # Conflicts: # README.md
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
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.
Description
The README named its users twice at the top: once as a long sentence, and once as a bare bullet list of this Go package. This moves that material to a Users section near the end. Each system keeps its place in the list, now with its full name, a one-line description, and a category.
An entry marked "this library" depends on this Go package. The others use the Java library, the C/C++ library, or their own implementation. A few names are brought up to date: Apache Druid is no longer marked incubating, LinkedIn Pinot is Apache Pinot, and Visual Studio Team Services is Azure DevOps Services.
Type of Change
Changes Made
What was changed?
Why was it changed?
How was it changed?
Testing
Not applicable. This pull request changes only
README.md.Formatting
Not applicable. No Go code changed.
Fuzzing
Not applicable. No Go code changed.
Performance Impact
None.
Breaking Changes
None.
Related Issues
None.
Additional Notes
The set of systems is the one already named in the README. No new users were added.