Skip to content

Commit

Permalink
bumped version and cleaned up Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
aziz committed Feb 9, 2016
1 parent 41b8b12 commit e455a1d
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 7 deletions.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "diff-so-fancy",
"version": "0.1.1",
"version": "0.1.2",
"description": "good-lookin' output of diff-highlight to upgrade your diffs' appearances",
"bin": {
"diff-so-fancy": "diff-so-fancy",
Expand Down
15 changes: 9 additions & 6 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# diff-so-fancy

diff-so-fancy builds on the good-lookin' output of diff-highlight to upgrade your diffs' appearances
* Output will not be in standard patch format, but will be readable
diff-so-fancy builds on the good-lookin' output of diff-highlight to upgrade
your diffs' appearances.

* Output will not be in standard patch format, but will be readable.
* No pesky `+` or `-` at line-stars, making for easier copy-paste.

## Screenshot

*`git diff` vs `git diff | diff-so-fancy`*
*`git diff` vs `git diff --color | diff-highlight | diff-so-fancy`*

![diff-highlight vs diff-so-fancy](https://cloud.githubusercontent.com/assets/39191/10000682/8e849130-6052-11e5-9bd9-bd4505cd24d6.png)

Expand All @@ -28,7 +30,7 @@ npm install -g diff-so-fancy
```
This will install and link the `diff-so-fancy` and `diff-highlight` scripts.

### GNU sed.
### GNU sed.
On Mac, install it with Homebrew.
```shell
brew install gnu-sed --with-default-names # You'll have to change below to `gsed` otherwise
Expand All @@ -43,8 +45,9 @@ git config --global color.diff-highlight.newHighlight "green bold 22"
```
You may also want to configure [general diff colors](https://github.com/paulirish/dotfiles/blob/63cb8193b0e66cf80ab6332477f1f52c7fbb9311/.gitconfig#L23-L36).

### `diff-highlight`
It's installed via the `diff-so-fancy` npm package. But it's also shipped with Git so, if you prefer, you can add it to your `$PATH` manually:
### `diff-highlight`
It's installed via the `diff-so-fancy` npm package. But it's also shipped with
Git so, if you prefer, you can add it to your `$PATH` manually:
```shell
ln -sf "$(brew --prefix)/share/git-core/contrib/diff-highlight/diff-highlight" ~/bin/diff-highlight
# confirm that ~/bin is in your PATH
Expand Down

0 comments on commit e455a1d

Please sign in to comment.