diff --git a/README.md b/README.md index d3d6588..5fc3731 100644 --- a/README.md +++ b/README.md @@ -2,34 +2,23 @@ allows overwrite object field value using abstract path ## software requirements - * node.js 6.9+ [with v8 enabled] - * npm 3+ + * node.js v6.9+ [with v8 enabled] + * npm v3+ ## used technologies - * jest + * jest _[for tests only]_ ## how to execute tests -``` -npm test -``` -to execute tests with coverage -``` -npm test -- --coverage -``` + `npm test` or, to execute tests with coverage `npm test -- --coverage` ## how to use +`import resolve from "node-object-field-resolver";` or `const resolve = require("node-object-field-resolver");` ``` -import overwriteObjectField from "node-object-field-resolver" -# or, if you use pure node.js: -const overwriteObjectField = require("node-object-field-resolver"); - -... let object = {xxx: 'value'} # given object -object = overwriteObjectField('xxx.yyy', object, 'new value', '.'); # result: object ~ {xxx: { yyy: 'new value'} } +object = resolve('xxx.yyy', object, 'new value', '.'); -> result: object ~ {xxx: { yyy: 'new value'} } can be used as well as: -overwriteObjectField('xxx.yyy', object, 'new value') # as objects are passed as via reference and get modified in proccess - + resolve('xxx.yyy', object, 'new value') -> as objects are passed as reference and get modified in proccess ```