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.

Sign up for GitHub

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

Jump to bottom

Docs: restructure and enhance the usage section #12

Merged
merged 3 commits into from
Sep 15, 2017
Merged

Docs: restructure and enhance the usage section #12

merged 3 commits into from
Sep 15, 2017

Conversation

aichbauer
Copy link
Owner

@JPeer264 do you have an idea, how to enhance the README.md

@aichbauer aichbauer requested a review from JPeer264 September 14, 2017 22:50
@coveralls
Copy link

coveralls commented Sep 14, 2017 •
edited
Loading

Coverage Status

Coverage remained the same at 97.436% when pulling f11a898 on docs/enhance into a529f87 on master.

@coveralls
Copy link

coveralls commented Sep 14, 2017 •
edited
Loading

Coverage Status

Coverage remained the same at 97.436% when pulling ac25c27 on docs/enhance into a529f87 on master.

JPeer264
JPeer264 requested changes Sep 15, 2017
View reviewed changes
Copy link
Collaborator

@JPeer264 JPeer264 left a comment

Choose a reason for hiding this comment

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

Couldn't think of any other enhancements.

README.md Outdated
# generates the complete CHANGELOG.md without backup
$ sgr --recover # or short `sgr -r`
# generates the complete CHANGELOG.md with backup
$ sgr -r backup # or short `sgr -r b`
Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe write $sgr --recover backup, as you write the short flag anyway in the comment.

@coveralls
Copy link

coveralls commented Sep 15, 2017 •
edited
Loading

Coverage Status

Coverage remained the same at 97.436% when pulling 3fa6a48 on docs/enhance into a529f87 on master.

JPeer264
JPeer264 approved these changes Sep 15, 2017
View reviewed changes
Copy link
Collaborator

@JPeer264 JPeer264 left a comment

Choose a reason for hiding this comment

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

LGTM

@aichbauer aichbauer merged commit 75b0ee6 into master Sep 15, 2017
@aichbauer aichbauer deleted the docs/enhance branch October 11, 2017 17:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JPeer264 JPeer264 JPeer264 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@aichbauer @coveralls @JPeer264