Improve Readme

[scottgallant]

I'm loving this project but I just sent it to someone and when I look at the readme, I’m left wondering why I should use it. What does it get me and how is it better than just building a plain old Jekyll site? Is Browsersync wired up? Is postCSS better? Is Sass included? Does my minification and concatenation happen for me? What are templates? Why am I better off using it.

I'm wondering if people have ideas on how to better describe this project.

Current Ideas

(Ideas proposed by the community will be collected here)

• Highlight features of, and tools used by, static-scripts.
• Guides
  • How to use static-scripts with your static site. (Generic)
  • How to migrate an existing Jekyll site to using static-scripts
  • How to migrate an existing Hugo site to using static-scripts
• docs on options when generating projects. See angular-cli docs

[ncphillips]

Having a FAQ section in the README might be good. One of the questions could by "Why PostCSS?" @chrisdmacrae @itsnwa if there are any articles on PostCSS and why you should use it, then post them here.

[Koslun]

Largely agree with the above.

Though I think it's largely more important to highlight any big tools or features included than outline why they're good to use. Postcss, browsersync, Uglify/minification and CSS preprocessors supported are all examples of things I figure would be good to include.

In the abscence of more details I only glance that babel and postcss is being used.

I would also consider adding some more details on how a generated Jekyll or Hugo project can be expected to look like. In our case I figure it would be neat to faster determine the effort it'd take for us to migrate an existing Jekyll project to using this CLI.

If there are any options for generating projects, something similar to what angular-cli has would be nice: https://github.com/angular/angular-cli/wiki/new