Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the README file to have better grammar, and more useful info #16

Merged
merged 1 commit into from
Jul 16, 2018

Conversation

theckman
Copy link
Member

This updates the README.md file to improve the grammar and phrasing of certain
sentences, as well as to be more precise or provide clarifications where needed.

This also adds a section to point to the origin of this
repo (github.com/satori/go.uuid) and mentions why the fork happened.

This also introduces a new License and Go Report Card badge at the top of the
file.

Signed-off-by: Tim Heckman t@heckman.io

@coveralls
Copy link

coveralls commented Jul 15, 2018

Pull Request Test Coverage Report for Build 54

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 98.137%

Totals Coverage Status
Change from base Build 39: 0.0%
Covered Lines: 316
Relevant Lines: 322

💛 - Coveralls

@theckman theckman force-pushed the update_readme branch 2 times, most recently from 0d31ea4 to 44076ff Compare July 15, 2018 03:11
README.md Outdated

## Requirements

UUID package is tested for Go >= 1.3.
Go 1.2 may work, but it is not tested and support for this version is not actively maintained.
This package is regularly tested against Go 1.3+, due issues with the testing
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

due to issues with the testing...

itsjamie
itsjamie previously approved these changes Jul 15, 2018
Copy link
Contributor

@itsjamie itsjamie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other than the little stumble I had reading LGTM.

This updates the `README.md` file to improve the grammar and phrasing of certain
sentences, as well as to be more precise or provide clarifications where needed.

This also adds a section to point to the origin of this
repo (`github.com/satori/go.uuid`) and mentions why the fork happened.

This also introduces a new License and Go Report Card badge at the top of the
file.

Signed-off-by: Tim Heckman <t@heckman.io>
Copy link
Member

@niaow niaow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All looks good!

@theckman theckman merged commit 6bfd6b4 into master Jul 16, 2018
theckman added a commit that referenced this pull request Jul 16, 2018
Update the README file to have better grammar, and more useful info

Signed-off-by: Tim Heckman <t@heckman.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants