improve readme #21
Merged
improve readme #21
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
rfay
approved these changes
Nov 7, 2023
There was a problem hiding this comment.
This looks like an improvement to me, thanks. We'll let @AronNovak pipe up here. Let's not forget to do a release to get your new image version in there.
AronNovak
approved these changes
Nov 8, 2023
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.
The Issue
How This PR Solves The Issue
Manual Testing Instructions
Read the new readme sections and try to follow the things it provides.
Automated Testing Overview
Not possible for readme. I thought about adding memory limit checks but did not see much value.
Related Issue Link(s)
No related issues.
Release/Deployment Notes
Nothing needs to be done.