Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
scottchiefbaker committed Apr 24, 2020
1 parent 0b86356 commit 70d4d9d
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

`diff-so-fancy` strives to make your diffs **human** readable instead of machine readable. This helps improve code quality and helps you spot defects faster.


## Screenshot

Vanilla `git diff` vs `git` and `diff-so-fancy`
Expand All @@ -11,10 +10,11 @@ Vanilla `git diff` vs `git` and `diff-so-fancy`

## Install

Installation is as simple as downloading the [`diff-so-fancy`](https://raw.githubusercontent.com/so-fancy/diff-so-fancy/master/third_party/build_fatpack/diff-so-fancy) script to a directory in your path.
Windows users may need to install [MinGW](https://sourceforge.net/projects/mingw/files/) or the [Windows subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10).
Installation is as simple as cloning this repo and then putting the `diff-so-fancy` script in to your `$PATH`. The `lib/` directory will need to be kept relative to the core script.

`diff-so-fancy` is also available from NPM, Nix, brew, and as a package on Arch and Debian Linux.

`diff-so-fancy` is also available from NPM, Nix, brew, and as a package on Arch Linux.
**Note:** Windows users may need to install [MinGW](https://sourceforge.net/projects/mingw/files/) or the [Windows subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10).

## Usage

Expand Down Expand Up @@ -86,6 +86,16 @@ By default, the separator for the file header spans the full width of the termin
git config --global diff-so-fancy.rulerWidth 47 # git log's commit header width
```

## The diff-so-fancy team

| Person | Role |
| --------------------- | ---------------- |
| @scottchiefbaker | Project lead |
| @OJFord | Bug triage |
| @GenieTim | Travis OSX fixes |
| @AOS | Debian packager |
| @Stevemao/@Paul Irish | NPM release team |

## Contributing

Pull requests are quite welcome, and should target the [`next` branch](https://github.com/so-fancy/diff-so-fancy/tree/next). We are also looking for any feedback or ideas on how to make `diff-so-fancy` even *fancier*.
Expand Down

0 comments on commit 70d4d9d

Please sign in to comment.