Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme: example of diff output #27

Open
TehShrike opened this issue Jun 23, 2017 · 3 comments
Open

Readme: example of diff output #27

TehShrike opened this issue Jun 23, 2017 · 3 comments

Comments

@TehShrike
Copy link

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
Copy link
Member

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
Copy link
Member

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

@jasikpark
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants