Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ptumati authored Dec 3, 2017
1 parent 604c9c9 commit 294a092
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Object Mutator
=========

A small library that lets you generate mutations of a Javascript object at the property level
A small library that lets you generate mutations of a Javascript object at the property level. (See http://www.tumati.com/objectmutator-js-generating-all-or-some-subset-of-combinations-an-object-at-the-property-or-key-value-pair-level/.)


## Usage
Expand Down Expand Up @@ -33,12 +33,15 @@ A small library that lets you generate mutations of a Javascript object at the p
- 'c' ranges from -1 to 3, stepping by 1
- 'd' remains the same in every object as it was passed in using the chromosome parameter

(* 'a' eventually gets filtered by the 'cullFunction', where the values that were generated with a from 5 to 7 are dropped. This is just an example! The cullFunction is useful for making sure that, in a new generation of objects, that certain objects are removed because of invalid relationships between properties.)
(* 'a' eventually gets filtered by the 'cullFunction', where the values that were generated
with a from 5 to 7 are dropped. This is just an example! The cullFunction is useful for making
sure that, in a new generation of objects, that certain objects are removed because of invalid
relationships between properties.)

## Tests

`npm test`

## Contributing

In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.
In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.

0 comments on commit 294a092

Please sign in to comment.