Skip to content

Commit

Permalink
upgrade the markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
James Halliday committed Oct 14, 2013
1 parent 69fae5a commit 30e1f8f
Showing 1 changed file with 9 additions and 14 deletions.
23 changes: 9 additions & 14 deletions README.markdown
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
deep-equal
==========
# deep-equal

Node's `assert.deepEqual() algorithm` as a standalone module.

Expand All @@ -10,8 +9,7 @@ than wrapping `assert.deepEqual()` in a `try/catch`.

[![build status](https://secure.travis-ci.org/substack/node-deep-equal.png)](http://travis-ci.org/substack/node-deep-equal)

example
=======
# example

``` js
var equal = require('deep-equal');
Expand All @@ -27,13 +25,13 @@ console.dir([
]);
```

methods
=======
# methods

``` js
var deepEqual = require('deep-equal')
```

deepEqual(a, b, opts)
---------------------
## deepEqual(a, b, opts)

Compare objects `a` and `b`, returning whether they are equal according to a
recursive equality algorithm.
Expand All @@ -42,25 +40,22 @@ If `opts.strict` is `true`, use strict equality (`===`) to compare leaf nodes.
The default is to use coercive equality (`==`) because that's how
`assert.deepEqual()` works by default.

install
=======
# install

With [npm](http://npmjs.org) do:

```
npm install deep-equal
```

test
====
# test

With [npm](http://npmjs.org) do:

```
npm test
```

license
=======
# license

MIT. Derived largely from node's assert module.

0 comments on commit 30e1f8f

Please sign in to comment.