Skip to content
This repository has been archived by the owner on Sep 15, 2019. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tones31 authored Oct 17, 2016
1 parent bfbfb19 commit 2d7be98
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 2d7be98

Please sign in to comment.