diff --git a/README.md b/README.md index 475fd77..c83a006 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ npm install deap var deap = require('deap'); ``` -### Available functions +### available functions + deap() and deap.extend() - **deep extend** + deap.merge() - **deep merge** @@ -49,3 +49,17 @@ Takes *n* number of arguments, modifies the first argument and returns it. var a = { name: 'Joe', phone: '' }; deap.merge(a, { age: 26, phone: '555-555-5555' }); // returns: a => { name: 'Joe', phone: '555-555-5555' } ``` + +--- + +## shallow only + +If you prefer a shallow-only instance of **deap** you can require it specifically + +```javascript +var deap = require('deap/shallow'); + +deap() && deap.extend(); // shallow extend +deap.merge(); //shallow merge +deap.clone(); // deep clone +```