diff --git a/README.md b/README.md index 23a3ffcb8..96e994917 100644 --- a/README.md +++ b/README.md @@ -11,44 +11,28 @@ their syntax. See [the manual](http://difftastic.wilfred.me.uk/) to get started. -## Demo 1: Wrapping Expressions +## Basic Example -Difftastic understands expression nesting. If you wrap an expression -in an if statement, difftastic understands that the inner values are -unchanged. +![Screenshot of difftastic and JS](img/js.png) -![Elisp screenshot](img/elisp.png) +In this JavaScript example, we can see: -Compare this with git's default diff. It is confused by indentation -changes, and doesn't know which closing parenthesis has been added. +(1) Difftastic understands nesting. It highlights the matching `{` and +`}`, but understands that `foo()` hasn't changed despite the leading +whitespace. -![Elisp comparison screenshot](img/elisp_comparison.png) +(2) Difftastic understands which lines should be aligned. It's aligned +`bar()` on the left with `bar(1)` on the right, despite their changes. -## Demo 2: Reflowing Code +(3) Difftastic understands that line-wrapping isn't +meaningful. `"eric"` is now on a new line, but it hasn't changed. -Difftastic is robust to code formatting changes. If you change how -many items appear on a single line, difftastic will only show you -items which have changed. +## One Minute Demo -![Rust screenshot](img/rust.png) +[![asciicast](https://asciinema.org/a/480875.svg)](https://asciinema.org/a/480875) -In git's default diff, it's harder to see that `iter` and the curly -braces are unchanged. It's also harder to see the affected line numbers. - -![Rust comparison screenshot](img/rust_comparison.png) - - +This one minute screencast demonstrates difftastic usage with both +standalone files and git. ## Languages diff --git a/img/elisp.png b/img/elisp.png deleted file mode 100644 index 40ac17706..000000000 Binary files a/img/elisp.png and /dev/null differ diff --git a/img/elisp_comparison.png b/img/elisp_comparison.png deleted file mode 100644 index 502b02e01..000000000 Binary files a/img/elisp_comparison.png and /dev/null differ diff --git a/img/js.png b/img/js.png new file mode 100644 index 000000000..d60e33157 Binary files /dev/null and b/img/js.png differ diff --git a/img/rust.png b/img/rust.png deleted file mode 100644 index a7d6ce0f8..000000000 Binary files a/img/rust.png and /dev/null differ diff --git a/img/rust_comparison.png b/img/rust_comparison.png deleted file mode 100644 index 22742f2d5..000000000 Binary files a/img/rust_comparison.png and /dev/null differ