Skip to content

Commit

Permalink
Add coveralls to README
Browse files Browse the repository at this point in the history
  • Loading branch information
vkarpov15 committed Jan 1, 2015
1 parent adea794 commit fb52369
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 3 deletions.
35 changes: 34 additions & 1 deletion README.md
@@ -1,4 +1,6 @@
# kareem [![Build Status](https://travis-ci.org/vkarpov15/kareem.svg?branch=master)](https://travis-ci.org/vkarpov15/kareem)
# kareem

[![Build Status](https://travis-ci.org/vkarpov15/kareem.svg?branch=master)](https://travis-ci.org/vkarpov15/kareem) [![Coverage Status](https://img.shields.io/coveralls/vkarpov15/kareem.svg)](https://coveralls.io/r/vkarpov15/kareem)

Re-imagined take on the [hooks](http://npmjs.org/package/hooks) module, meant to offer additional flexibility in allowing you to execute hooks whenever necessary, as opposed to simply wrapping a single function.

Expand Down Expand Up @@ -180,6 +182,37 @@ Named for the NBA's all-time leading scorer Kareem Abdul-Jabbar, known for his m

```

#### It can use synchronous post hooks

```javascript

var execed = {};

hooks.post('cook', function(eggs, bacon) {
execed.first = true;
assert.equal(1, eggs);
assert.equal(2, bacon);
});

hooks.post('cook', function(eggs, bacon, callback) {
execed.second = true;
assert.equal(1, eggs);
assert.equal(2, bacon);
callback();
});

hooks.execPost('cook', null, [1, 2], function(error, eggs, bacon) {
assert.ifError(error);
assert.equal(2, Object.keys(execed).length);
assert.ok(execed.first);
assert.ok(execed.second);
assert.equal(1, eggs);
assert.equal(2, bacon);
done();
});

```

## wrap()

#### It wraps pre and post calls into one call
Expand Down
5 changes: 3 additions & 2 deletions docs.js
Expand Up @@ -4,8 +4,9 @@ var content = require('fs').readFileSync('./test/examples.test.js').toString();
var blocks = acquit.parse(content);

var mdOutput =
'# kareem ' +
'[![Build Status](https://travis-ci.org/vkarpov15/kareem.svg?branch=master)](https://travis-ci.org/vkarpov15/kareem)\n\n' +
'# kareem\n\n' +
'[![Build Status](https://travis-ci.org/vkarpov15/kareem.svg?branch=master)](https://travis-ci.org/vkarpov15/kareem) ' +
'[![Coverage Status](https://img.shields.io/coveralls/vkarpov15/kareem.svg)](https://coveralls.io/r/vkarpov15/kareem)\n\n' +
'Re-imagined take on the [hooks](http://npmjs.org/package/hooks) module, ' +
'meant to offer additional flexibility in allowing you to execute hooks ' +
'whenever necessary, as opposed to simply wrapping a single function.\n\n' +
Expand Down

0 comments on commit fb52369

Please sign in to comment.