create `standard-readme` layout
See original GitHub issueI’m going to major standardizing and my flow would soon be totally automated, crazy and awesome. I’m using the “standards” - standard
, semantic releasing with standard-version
(which is almost the same as semantic-release
), and wanna have standard readmes too.
offtopic: What I imagine:
- generate-repo - creates repo on github, labels, sync travis/coveralls site? etc, init and possibly first commit
- generate project - creates any templates
- writing the modules
- verb
- git add --all -> git cz (commit using commitizen) -> (standard-version, not always), git push (–follow-tags, if standard-version), (npm publish, if standard-version)
Issue Analytics
- State:
- Created 7 years ago
- Comments:11 (10 by maintainers)
Top Results From Across the Web
A standard style for README files
Standard Readme is designed for open source libraries. Although it's historically made for Node and npm projects, it also applies to libraries in...
Read more >Make a README
Learn how to make a great README for your programming project, and use the editable template to get started.
Read more >README.md template | Documenting your project
Information about content and formatting of project README files.
Read more >How to Write a Good README File for Your GitHub Project
It is the first file a person will see when they encounter your project, so it should be fairly brief but detailed. ·...
Read more >Readme Template: How to write a kickass README
What should you include in a README? · 1. Name the thing. Don't forget to give your project or feature a name. ·...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
I just looked. I have zero interest in supporting that. I tried commenting in the one discussion and the response(s) to my comment were childish, and it seemed like they were actively discouraging others from commenting. Someone even commented that they didn’t like my style of readmes. That’s fine, but given that I have more of them, more experience writing them, and more tools for creating them than any other GitHub user to my knowledge, I would have at least hoped to be a part of the discussion.
I even commented that my decisions are based on data, and someone had a problem with that. It was lame. I have 300 million downloads a month to guide my decisions, not to mention the clicks that we track. It’s absurd for someone to not want insight from that.
How about if we fix the spec instead