diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..7a1537b --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +.idea +node_modules diff --git a/README.md b/README.md new file mode 100644 index 0000000..538f277 --- /dev/null +++ b/README.md @@ -0,0 +1,76 @@ +enb-ng-techs +============== + +[![NPM version](https://img.shields.io/npm/v/enb-ng-techs.svg?style=flat)](https://www.npmjs.org/package/enb-ng-techs) + +Useful ENB technologies to build angular projects. + +Installation: +---------- + +```sh +$ npm install --save-dev enb-ng-techs +``` + +Techs +---------- + + * `ng-annotate` - adds AngularJS dependency injection annotations using [`ng-annotate`](https://github.com/olov/ng-annotate) + * `ng-templates` - combines `*.tmpl.html` files in single partial which can be loaded and compiled by Angular in runtime + +ng-annotate +========== + +Takes js file provided by `source` option and writes annotated result to file provided by `target` option. + +**Options** + +* *String* **source** — file-target to annotate. +* *String* **target** — file-target to write annotated output. + +**Example** + +```javascript +nodeConfig.addTech(require('enb-ng-techs/techs/ng-annotate'), { + source : '?.pre.js', + target : '?.annotated.js' +}); +``` + +ng-templates +========== + +Combines `*.tmpl.html` files by deps wrapping them out with `'; + }) + .createTech();