Skip to content

Commit

Permalink
fixed example, added READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
warmuuh committed Feb 26, 2013
1 parent 3a959e5 commit d89c9d4
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 2 deletions.
8 changes: 7 additions & 1 deletion README.md
Expand Up @@ -2,4 +2,10 @@

Yaap is a generic annotation processor for javascript. It can be used to implement cross-cutting concerns and inject additional aspect oriented code.

See [Readme](yaap/README.md) for more information.
See [Readme](yaap/README.md) for more information.


There are also two examples for server and client scenario:

* On [Node](node-example)
* In [Browser](browser-example)
5 changes: 5 additions & 0 deletions browser-example/README.md
@@ -0,0 +1,5 @@
#Yaap in a browser

The Example uses cujo.js to annotate and autowire a class.

use `bower install` to install dependencies
2 changes: 1 addition & 1 deletion browser-example/index.html
Expand Up @@ -11,7 +11,7 @@
packages: {
wire: { path: 'components/wire', main: 'wire'},
when: { path: 'components/when/', main: 'when'},
yaap: { path: '../yaap/', main: 'yaap'},
yaap: { path: 'components/yaap/yaap', main: 'yaap'},
meld: { path: 'components/meld', main: 'meld' },
underscore:{ path: 'components/underscore', main: 'underscore',
config: {moduleLoader: 'curl/loader/cjsm11'}
Expand Down
5 changes: 5 additions & 0 deletions node-example/README.md
@@ -0,0 +1,5 @@
#Yaap in node

The Example uses cujo.js to annotate and autowire a class.

use `npm install` to install dependencies
5 changes: 5 additions & 0 deletions yaap/README.md
Expand Up @@ -106,3 +106,8 @@ module.exports = {
`Remark:` Yaap/wire uses the parameter name to autowire. You can also supply a reference name with `/*@Autowire("level")*/`

`Remark:` You can also annotate the whole function with `@Autowire` so every parameter will be autowired by name.

###Constructors
The yaap/wire plugin will be called after the bean was initialized. That means, the constructor itself will not be affected by annotations.

As a workaround, use a separate initialize-method (using the [init-facade](https://github.com/cujojs/wire/blob/master/docs/configure.md#init-methods) of wire).

0 comments on commit d89c9d4

Please sign in to comment.