Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kinvil_hsiao committed Mar 30, 2017
1 parent 0d96ff9 commit b239727
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 6 deletions.
26 changes: 23 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,27 @@
# node-objs
deal with js object
A light weight module to deal with js object.

[![Build Status](https://travis-ci.org/kinvil/node-objs.svg?branch=master)](https://travis-ci.org/kinvil/node-objs)
[![Coverage Status](https://coveralls.io/repos/github/kinvil/node-objs/badge.svg?branch=master)](https://coveralls.io/github/kinvil/node-objs?branch=master)


## install
```
npm install --save node-objs
```
npm install node-objs --save
```

## example

```
import { clone, isEqual } from 'node-objs'
const obj = { foo: 'bar' }
const newObj = clone(obj)
console.log(newObj) // { foo: 'bar' }
obj === newObj // false
isEqual(obj, newObj) // true
obj.foo = 'text' // { foo: 'text' }
console.log(newObj) // { foo: 'bar' }
isEqual(obj, newObj) // false
```
5 changes: 2 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "node-objs",
"version": "0.0.3",
"version": "0.0.4",
"description": "deal with js object",
"main": "./index.js",
"scripts": {
Expand All @@ -25,7 +25,6 @@
"coveralls": "^2.12.0",
"expect.js": "^0.3.1",
"istanbul": "^0.4.5",
"mocha": "^3.2.0",
"mocha-lcov-reporter": "^1.3.0"
"mocha": "^3.2.0"
}
}

0 comments on commit b239727

Please sign in to comment.