concordancejs / concordance

Compare, format, diff and serialize any JavaScript value

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Readme: example of diff output

TehShrike opened this issue · comments

The docs say "Concordance strives to format every aspect of a value that is used for comparisons. Formatting is optimized for human legibility", but never give any examples of diff output - I'm a lazy person just browsing around libraries on Github, so I'm not motivated enough to install the library and poke at it in the REPL, but I am curious as to what the library does.

Examples of human-readable object/value diffing in the readme would be useful.

Agreed. I just haven't had the time yet to add examples. We'll be shipping this in AVA soon so that'll help.

Until the readme is updated, you can see some examples here: https://twitter.com/ava__js/status/880125395680546816

It would also be great to have documentation for how to use this 😅