Skip to content

Commit 6711dd4

Browse files
Merge pull request #13 from explore-node-js/eugene-matvejev-patch-2
update README.md
2 parents 035e4eb + 630a650 commit 6711dd4

File tree

1 file changed

+7
-18
lines changed

1 file changed

+7
-18
lines changed

README.md

Lines changed: 7 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,34 +2,23 @@
22
allows overwrite object field value using abstract path
33

44
## software requirements
5-
* node.js 6.9+ [with v8 enabled]
6-
* npm 3+
5+
* node.js v6.9+ [with v8 enabled]
6+
* npm v3+
77

88
## used technologies
9-
* jest
9+
* jest _[for tests only]_
1010

1111
## how to execute tests
12-
```
13-
npm test
14-
```
15-
to execute tests with coverage
16-
```
17-
npm test -- --coverage
18-
```
12+
`npm test` or, to execute tests with coverage `npm test -- --coverage`
1913

2014
## how to use
15+
`import resolve from "node-object-field-resolver";` or `const resolve = require("node-object-field-resolver");`
2116

2217
```
23-
import overwriteObjectField from "node-object-field-resolver"
24-
# or, if you use pure node.js:
25-
const overwriteObjectField = require("node-object-field-resolver");
26-
27-
...
2818
let object = {xxx: 'value'} # given object
2919
30-
object = overwriteObjectField('xxx.yyy', object, 'new value', '.'); # result: object ~ {xxx: { yyy: 'new value'} }
20+
object = resolve('xxx.yyy', object, 'new value', '.'); -> result: object ~ {xxx: { yyy: 'new value'} }
3121
3222
can be used as well as:
33-
overwriteObjectField('xxx.yyy', object, 'new value') # as objects are passed as via reference and get modified in proccess
34-
23+
resolve('xxx.yyy', object, 'new value') -> as objects are passed as reference and get modified in proccess
3524
```

0 commit comments

Comments
 (0)