This repository has been archived by the owner on Dec 18, 2024. It is now read-only.
Improve Databroker README #707
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
The README file has been restructured based on best practices. Much of the usage information has been moved into a separate User Guide document, resulting in a condensed README which focuses on setting the context, outlining the projects features and benefits and getting users started quickly.
sophokles73
force-pushed
the
improve_readme
branch
from
398dbba to
a089ec1
Compare
|
@craigmateo would you mind to also take a look? |
|
Looks like an improvement. We can iterate on it in the future based on feedback from the community. |
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.
The README file has been restructured based on best practices.
Much of the usage information has been moved into a separate User
Guide document, resulting in a condensed README which focuses on
setting the context, outlining the projects features and benefits
and getting users started quickly.