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

Conform README to standard-readme #558

Closed
RichardLitt opened this issue Jul 6, 2016 · 1 comment

Comments

@RichardLitt
Copy link
Contributor

commented Jul 6, 2016

I made Standard-Readme for the same reasons that standard exists, and based partly on this idea. Would you be open to accepting a PR conforming the README to it?

https://github.com/RichardLitt/standard-readme

@feross

This comment has been minimized.

Copy link
Member

commented Jul 12, 2016

Can you send a PR that contains the most minimal changes necessary to conform to your standard so we can take a look?

@feross feross closed this Jul 12, 2016

RichardLitt added a commit to RichardLitt/standard that referenced this issue Jul 27, 2016

Standardize Readme
This is the most minimal change to standardize the README, following RichardLitt/standard-readme. See standard#558 for more on this.

Big changes: Move the title and the badges, take away the centering. This is a bit less pretty, but you should not have to think about this stuff, and standardizing will remove some aesthetic decisions, sadly. I also added a contribute, a Table of Contents, and moved badges into usage - I think this is the best move. Linked to the license. What do you think?

@feross feross added enhancement and removed enhancement labels May 10, 2018

@lock lock bot locked as resolved and limited conversation to collaborators Aug 8, 2018

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
3 participants
You can’t perform that action at this time.