dwyl / goodparts

:see_no_evil: An ESLint Style that only allows JavaScript the Good Parts (and "Better Parts") in your code.

GNU General Public License v2.0

78 stars 26 forks source link

Tidy up so we can Publicise this! #263

Open nelsonic opened 7 years ago

nelsonic commented 7 years ago

As a person new to this repo/project the README.md feels "unpolished". This will

Tasks/Todo:

[ ] Re-read the readme with "shoshin" eyes and
- [ ] substitute any "long" words for more beginner-friendly vocab.
- [ ] correct any typos in the readme (editor with good English/grammar skills required!) e.g: piers >> peers
- [ ] where a technical term is required ensure it is hyperlinked
- [ ] align all "badges" on a single line for consistency
- [ ] add instructions for how to include the goodparts badge! https://github.com/dwyl/goodparts/issues/253
- [ ] add some <br /> space between "main" section of readme and tldr; section
- [ ] ... anything else that you spot that we can improve. (please leave a comment in this issue to discuss before making the change, thanks!)
[ ] close off all open issues so it does not look like there are "bugs" ...

iteles commented 7 years ago

Adding a line specifically around why we've gone with 'no ES6' is probably also worthwhile: https://github.com/dwyl/goodparts/issues/144#issuecomment-258212284 (thanks @eliascodes !)

iteles commented 7 years ago

12 is also relevant here.