Update README.md #88
Merged
Update README.md #88
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
Added documentation on "no version" feature.
koral--
approved these changes
May 31, 2021
mockitoguy
approved these changes
Jun 3, 2021
| @@ -19,9 +19,9 @@ Encourage and help software developers set up their releases to be fully automat | |||
| # shipkit-auto-version Gradle Plugin | |||
There was a problem hiding this comment.
Can you also update the "shipkit-auto-version Gradle Plugin" section? That section indicates that you need a version.properties file. Perhaps we can simplify this section to avoid duplication with "Usage" section.
README.md
Outdated
|
|
||
| ## Usage | ||
| ## USAGE |
There was a problem hiding this comment.
Nit: Let's use lowercase consistently (or uppercase), e.g. Usage here or CAPITAL everywhere else for headers
There was a problem hiding this comment.
Thanks for review! The documentation is now updated with your suggestions.
Simplified 'about' section of README.md and added short info about new feature. Details are contained in 'usage' section.
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.
Updated documentation on recently added "no version property" feature that allows deducing version based on annotated tag.