Skip to content

Commit c2e5c80

Browse files
committed
add readme.md
1 parent bb33968 commit c2e5c80

File tree

1 file changed

+62
-1
lines changed

1 file changed

+62
-1
lines changed

README.md

Lines changed: 62 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,63 @@
11
# karma-power-assert
2-
A Karma plugin. Adapter for power-assert assertion library.
2+
3+
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/watilde/karma-power-assert)
4+
[![npm version](https://img.shields.io/npm/v/karma-power-assert.svg?style=flat-square)](https://www.npmjs.com/package/karma-power-assert) [![npm downloads](https://img.shields.io/npm/dm/karma-power-assert.svg?style=flat-square)](https://www.npmjs.com/package/karma-power-assert)
5+
6+
[![Build Status](https://img.shields.io/travis/watilde/karma-power-assert/master.svg?style=flat-square)](https://travis-ci.org/watilde/karma-power-assert) [![Dependency Status](https://img.shields.io/david/watilde/karma-power-assert.svg?style=flat-square)](https://david-dm.org/watilde/karma-power-assert) [![devDependency Status](https://img.shields.io/david/dev/watilde/karma-power-assert.svg?style=flat-square)](https://david-dm.org/watilde/karma-power-assert#info=devDependencies)
7+
8+
> Adapter for [power-assert](https://github.com/power-assert-js/power-assert) assertion library.
9+
10+
## Installation
11+
via npm
12+
```bash
13+
$ npm install karma-power-assert --save-dev
14+
```
15+
16+
Instructions on how to install `karma` can be found [here.](http://karma-runner.github.io/0.12/intro/installation.html)
17+
18+
19+
## Configuration
20+
Following code shows the default configuration...
21+
```js
22+
// karma.conf.js
23+
module.exports = function(config) {
24+
config.set({
25+
frameworks: ['mocha', 'power-assert'],
26+
27+
files: [
28+
'*.js'
29+
]
30+
});
31+
};
32+
```
33+
34+
If you want to pass configuration options directly to `assert.customize` you can
35+
do this in the following way
36+
37+
```js
38+
// karma.conf.js
39+
module.exports = function(config) {
40+
config.set({
41+
frameworks: ['mocha', 'power-assert'],
42+
43+
files: [
44+
'*.js'
45+
],
46+
47+
client: {
48+
assert: {
49+
output: {
50+
maxDepth: 2
51+
}
52+
}
53+
}
54+
});
55+
};
56+
```
57+
58+
----
59+
60+
For more information on Karma see the [homepage].
61+
62+
63+
[homepage]: http://karma-runner.github.com

0 commit comments

Comments
 (0)