Readme: example of diff output

concordancejs / concordance

Compare, format, diff and serialize any JavaScript value

ISC License

207 stars 15 forks source link

Readme: example of diff output #27

Open TehShrike opened 7 years ago

TehShrike commented 7 years ago

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.

novemberborn commented 7 years ago

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

sindresorhus commented 7 years ago

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

jasikpark commented 3 years ago

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