aogriffiths / jsondiff-js

A JavaScript implementation to create json patches of the JSON Media Type for partial modifications: http://tools.ietf.org/html/draft-ietf-appsawg-json-patch-08. See also https://github.com/bruth/jsonpatch-js.
https://github.com/aogriffiths/jsondiff-js
BSD 2-Clause "Simplified" License
23 stars 11 forks source link

Description of the algorithm's behavior #10

Open fresheneesz opened 9 years ago

fresheneesz commented 9 years ago

It would be super helpful if you could describe the behavior of the algorithm in the docs. I'm not talking about explaining how it works, rather what kind of output it generates, and what kind of performance it has (where it shines and where it doesn't). Does it support generating 'move' and 'copy' typed changes? Does it attempt to minimize the number of changes in the patch at all?

Some explanation here would make it much easier to evaluate whether this module is appropriate in a given situation.