Skip to content

Commit cb82c8d

Browse files
docs: readme
1 parent c74627a commit cb82c8d

1 file changed

Lines changed: 13 additions & 2 deletions

File tree

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# deep-eql
1+
# deep-eql [![Build Status](https://travis-ci.org/chaijs/deep-eql.png?branch=master)](https://travis-ci.org/chaijs/deep-eql) [![Coverage Status](https://coveralls.io/repos/chaijs/deep-eql/badge.png?branch=master)](https://coveralls.io/r/chaijs/deep-eql?branch=master)
22

33
> Improved deep equality testing for Node.js and the browser.
44
@@ -16,11 +16,22 @@
1616

1717
$ component install chaijs/deep-eql
1818

19+
## Usage
20+
21+
### Rules
22+
23+
- Strict equality for non-traversable nodes according to [egal](http://wiki.ecmascript.org/doku.php?id=harmony:egal).
24+
- `eql(NaN, NaN).should.be.true;`
25+
- `eql(-0, +0).should.be.false;`
26+
- Arguments are not Arrays:
27+
- `eql([], arguments).should.be.false;`
28+
- `eql([], Array.prototype.slice.call(arguments)).should.be.true;`
29+
1930
## License
2031

2132
(The MIT License)
2233

23-
Copyright (c) 2012 Jake Luer <jake@alogicalparadox.com>
34+
Copyright (c) 2013 Jake Luer <jake@alogicalparadox.com>
2435

2536
Permission is hereby granted, free of charge, to any person obtaining a copy
2637
of this software and associated documentation files (the "Software"), to deal

0 commit comments

Comments
 (0)