selfup / hyperapp-one

Hyperapp One is a Parcel boilerplate for quickstarting a web application with Hyperapp (V1), JSX, and Prettier.
https://selfup.github.io/hyperapp-one
MIT License
126 stars 20 forks source link

Improve comments and tweak README. #30

Closed jorgebucaran closed 6 years ago

jorgebucaran commented 6 years ago

@selfup Thanks for putting up this repo! I like how it is aptly named as it was the very first Hyperapp boilerplate IIRC.

This PR attempts to improve the comment in index.js and makes some stylistic "adjustments" to the README. Mostly, bring the attention to what matters and not distract users with expendable verbiage.

You can improve it more by adding a section to the README explaining why to choose some of the technologies you are using, like Airbnb's JavaScript Styleguide, JSX, ESLint, etc.

selfup commented 6 years ago

Great! Yea I will add more to the README (in another PR) below all the useful instructions explaining my stylistic reasoning as well!

jorgebucaran commented 6 years ago

Great and thanks! Go ahead and make all the changes you want, this was just a very rough draft of what I had in mind. 👍