Massively improve README #208
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
|
Thanks for the improvement @echohack |
clintoncwolfe
pushed a commit
that referenced
this pull request
Feb 7, 2018
Signed-off-by: Sam Cornwell <14048146+samcornwell@users.noreply.github.com>
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 cleans up the README and uses stronger wording, more succinct language, and better style. It unifies the language that the website uses as well. https://www.chef.io/inspec/
The license belongs in the LICENSE file. Maintainers or Authors belong in a MAINTAINERS or AUTHORS file.
Eventually, parts of this README should be pulled into the documentation, such as the section on InSpec testing.