ff-attic/node-ff-assets
2
0
Fork 0
Code Activity

updated doc

Browse source
This commit is contained in:
Willem 2015-02-27 15:41:47 +01:00
parent ff3470022e
commit 65f989761a
1 changed files with 30 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
README.md
View file

@ -7,6 +7,10 @@ A Node.js library providing automatic site assets aggregation.
npm install node-ff-assets --save npm install node-ff-assets --save
## Example Application
There is a fully working bootstrap with angularjs example in the example folder.
## Usage ## Usage
// note1: www_static/[js/css]/lib is version ignored. // note1: www_static/[js/css]/lib is version ignored.
@ -113,8 +117,7 @@ A Node.js library providing automatic site assets aggregation.
## Config options ## Config options
The config option templates can be found in code; The config option of the objects are filled from config templates with defaults.
todo: add link
### Builder Config ### Builder Config
@ -172,6 +175,17 @@ A Node.js library providing automatic site assets aggregation.
assetSeperator: '\n/* '+name+': next */\n', assetSeperator: '\n/* '+name+': next */\n',
}; };
### Assembler Download Force
Sometimes its needed for have forces downloads of a resource.
This can be done by adding an extra @ sign.
'/static/js/lib/dynamic-generated.js@@http://localhost:8080/example-ui/include-js/generateModels;
note: if using localhost to download use the downloadStartDelay option so server is really up.
The downloadForce option will redownload all resources of asset group.
## Target/Source locations ## Target/Source locations
@ -195,7 +209,7 @@ A Node.js library providing automatic site assets aggregation.
filesystem file: www_static/js/ffa/jquery-2.1.3/jquery.js filesystem file: www_static/js/ffa/jquery-2.1.3/jquery.js
.gitignore line: www_static/js/ffa .gitignore line: www_static/js/ffa
if buildConfig.linkTargetSingleResult = true render if buildConfig.linkTargetSingleResult = true then result
static/js/ffa/assets.js static/js/ffa/assets.js
else else
static/js/site.js static/js/site.js
@ -401,7 +415,7 @@ A Node.js library providing automatic site assets aggregation.
## Tests ## Tests
npm test (TODO) npm test
## Contributing ## Contributing
@ -410,13 +424,17 @@ Add unit tests for any new or changed functionality. Lint and test your code.
## Release History ## Release History
* 0.2.0 ### 0.2.1
* redone objs * added example
* added tests * fixed buid callback
* made jslint pass * fixed buildOrder default
* 0.1.2 added objectAdd ### 0.2.0
* redone objs
* added tests
* made jslint pass
* 0.1.1 Doc updates ### 0.1.x
* added objectAdd
* 0.1.0 Initial release * Doc updates
* Initial release