Merge pull request #2 from e-conomic/0.2

Use chai.use for adding method

README.md

@@ -3,34 +3,40 @@ chai-subset [![Build Status](https://travis-ci.org/e-conomic/chai-subset.svg?bra
 
 "containSubset" object properties matcher for Chai
 
+Installation
+===========
+
+`npm install --save-dev chai-subset`
 
 Usage
 =====
 
 common.js
 ```js
-require('chai-subset').addMethods(chai);
+var chai = require('chai');
+var chaiSubset = require('chai-subset');
+chai.use(chaiSubset);
 ```
 
 spec.js
 ```js
 var obj = {
-		a: 'b',
-		c: 'd',
-		e: {
-			foo: 'bar',
-			baz: {
-				qux: 'quux'
-			}
+	a: 'b',
+	c: 'd',
+	e: {
+		foo: 'bar',
+		baz: {
+			qux: 'quux'
 		}
-	};
+	}
+};
 
 expect(obj).to.containSubset({
-			e: {
-				foo: 'bar',
-				baz: {
-					qux: 'quux'
-				}
-			}
-		});
+	e: {
+		foo: 'bar',
+		baz: {
+			qux: 'quux'
+		}
+	}
+});
 ```

lib/chai-subset.js

@@ -1,10 +1,4 @@
-module.exports =
-{
-	compare:compare,
-	addMethods:addMethod
-};
-
-function addMethod(chai) {
+module.exports = function(chai) {
 	chai.Assertion.addChainableMethod('containSubset', function (expected) {
 		var actual = this.__flags.object;
 		var msg = "\n" + JSON.stringify(actual, null, "\t") + "\n";
@@ -15,7 +9,7 @@ function addMethod(chai) {
 			expected
 		);
 	});
-}
+};
 
 function compare(expected, actual) {
 	if (typeof(actual) !== typeof(expected)) {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "chai-subset",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "description": "Object properties matcher for Chai",
   "main": "lib/chai-subset.js",
   "scripts": {

test/common.js

@@ -1,4 +1,4 @@
 var chai = require('chai');
-var containSubset = require("../lib/chai-subset");
+var chaiSubset = require("../lib/chai-subset");
 global.expect = chai.expect;
-containSubset.addMethods(chai);
+chai.use(chaiSubset);