From 2d7be98fc7e7fee027557a47c279ace0de3b2aca Mon Sep 17 00:00:00 2001 From: tones31 Date: Sun, 16 Oct 2016 23:05:23 -0400 Subject: [PATCH] Update README.md --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e6bde55..03e4c7a 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,14 @@ Web build automation to transpile ES6, minify CSS and JS, inject into HTML, and move files from a to b. Requires Node JS 6+. Uses `gulp` and many `gulp` modules. ## Use -`WebBuild` comes with 5 dead-simple functions to help you set up and build your front-end web application. The purpose of doing this is to minimize file requests and sizes between your server and clients. It also allows extremely easy sharing of common files without the need to include them in each HTML page. Look at the full tutorial in the [wiki](https://github.com/Voliware/WebBuild/wiki/tutorial). +`WebBuild` comes with 5 dead-simple functions to help you set up and build your front-end web application. The purpose of doing this is to minimize file requests and sizes between your server and clients. It also allows extremely easy sharing of common files without the need to include them in each HTML page. Read about each function in their wikis: + +1. [buildFileSys](https://github.com/Voliware/WebBuild/wiki/buildFileSys) - builds an object into a collection of file paths +2. [buildJs](https://github.com/Voliware/WebBuild/wiki/buildJs) - transpiles, concats, minfies, and renames scripts +3. [buildCss](https://github.com/Voliware/WebBuild/wiki/buildCss) - concats, minfies, and renames stylesheets +4. [buildInject](https://github.com/Voliware/WebBuild/wiki/buildInject) - injects HTML into HTML +5. [buildMove](https://github.com/Voliware/WebBuild/wiki/buildMove) - moves files from a to b + ### Gulp and Pump As a convenience, `WebBuild` also exposes and exports `gulp` and `buildPump`, which is a tiny wrapper around [pump](https://www.npmjs.com/package/pump) that simply logs error messages.