Improve Readme
See original GitHub issueHave content in the Readme to suit the project better
🐞 Problem
Currently, we have default Readme generated by Create React App
. As much as this is useful, we can have a Readme that’s tailored to this project that helps contributors and users better.
🎯 Goal Have a cool , awesome Readme
💡 Possible solutions Let’s have a discussion about what makes a Readme effective. What we need for this project etc
📋 Steps to solve the problem
- Comment down below the things you’d like to have (or be removed) in the Readme.
- Vote on things you like or those you find useful
- Submit pull requests to address the things we decide on.
Issue Analytics
- State:
- Created 4 years ago
- Comments:5 (5 by maintainers)
Top Results From Across the Web
10 useful sections to improve your Github README files
Today we are going to cover a list of 10 important sections you can add to your GitHub projects for improving your README...
Read more >How to Write a Good README File for Your GitHub Project
In this article, we'll learn more about what a README file is and how to ... There you have it, everything you need...
Read more >Improve README readability by froByte · Pull Request #639
Make important keywords italic Links are now parsed as links Highlights some specific words (e.g lib names, and directories)
Read more >Improve Readme [#3318832] | Drupal.org
Improving Readme File as suggested. We could be using README.md instead of README.txt to make use of the nicer rendering via markdown.
Read more >How To Improve Your WordPress Plugin's Readme.txt
If you're a plugin developer and you just love to write code, then writing a readme.txt file for a plugin in WordPress' repository...
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
@marianovarela awesome, you can share some of the ideas on the issue here or create a Work in Progress [WIP] PR with your proposed idea and tag us to review.
I’d say we rather remove it.
yarn
yarn start
is enough.