chore: editorial pass on the package README #103
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
moorec-aws
previously approved these changes
Apr 1, 2024
Summary: This adds some clarity to the README as to the purpose of this library, why one might want to use it, and how one would use it. I also eliminated all mention of "foreground" and "background" running modes in favour of a more general description of the Adaptor lifecycle and the CLI subcommands. Signed-off-by: Daniel Neilson <[email protected]>
ddneilson
force-pushed
the
ddneilson/rework_readme
branch
from
d8e57b0 to
8138ad6
Compare
moorec-aws
approved these changes
Apr 1, 2024
jusiskin
approved these changes
Apr 1, 2024
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.
What was the problem/requirement? (What/Why)
The package README should explain what the package is, and why one might want to use it.
What was the solution? (How)
This adds some clarity to the README as to the purpose of this library, why one might want to use it, and how one would use it. I also eliminated all mention of "foreground" and "background" running modes in favour of a more general description of the Adaptor lifecycle and the CLI subcommands.
What is the impact of this change?
Clarity
How was this change tested?
It's documentation.
Was this change documented?
It is documentation
Is this a breaking change?
No.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.