Overhaul the README #346
Merged
Overhaul the README #346
Conversation
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
This PR is me just going through the README and organzing this a bit different/better. I also removed a few things that can just be found elsewhere and in my opinion clog up the readme. - License -- This is displayed on GitHub and is still in the repo. There is no changes here to be clear, just removing it from the readmd. - Migration notes -- I've firm believer of not repeating things, so I'd like to instead have good release notes that talk about the changes and how to migrate to the newest versions. I've gone ahead and migrated the notes from the readme into the release page. For questions about migrating, please reference there in the future: https://github.com/scoverage/sbt-scoverage/releases
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.
This PR is me just going through the README and organzing this a bit
different/better. I also removed a few things that can just be found
elsewhere and in my opinion clog up the readme.
There is no changes here to be clear, just removing it from the
readmd.
like to instead have good release notes that talk about the changes
and how to migrate to the newest versions. I've gone ahead and
migrated the notes from the readme into the release page. For
questions about migrating, please reference there in the future:
https://github.com/scoverage/sbt-scoverage/releases