Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Updated readme.

  • Loading branch information...
commit b8204ffc3f17cf4e57dde337cc04d7b4fe5d25df 1 parent 73b2280
Scott González authored
Showing with 14 additions and 10 deletions.
  1. +14 −10 readme.md
24 readme.md
View
@@ -1,16 +1,16 @@
# Pretty Diff
Pretty diff generates colorized HTML diffs similar to the diff/commit views on GitHub.
-Simply use `git pd` the same way you use `git diff` and you'll get pretty diffs.
-If you want to share the diff, you can use `git gd` and you'll get a new gist.
+Simply use `pretty-diff` the same way you use `git diff` and you'll get pretty diffs.
+If you want to share the diff, you can use `gist-diff` and you'll get a new gist.
## Installation
-Clone the repo and then create a Git alias. Open `~/.gitconfig` and add:
+Simply install globally via npm:
- [alias]
- pd = !/path/to/pretty-diff.js
- gd = !/path/to/gist-diff.js
+```sh
+npm install -g pretty-diff
+```
## Usage
@@ -21,16 +21,20 @@ Simply provide whatever settings you want to pass to `git diff`.
For example, to see what changed in the last commit:
- git pd HEAD^
+ pretty-diff HEAD^
### gist-diff
gist-diff has one setting: `--public`.
-By default `git gist-diff` will generate a private gist.
+By default `gist-diff` will generate a private gist.
If `--public` is provided, the gist will be public.
-This setting can be specific anywhere (before or after the `git diff` settings.
+This setting can be specified anywhere (before or after the `git diff` settings).
gist-diff will attempt to create the gist using your GitHub account.
In order to create the gist with your account, you will be prompted for your password.
If you enter no password, then an anonymous gist will be generated.
-However, if you enter an incorrect password, then no gist will be generated.
+However, if you enter an incorrect password, then no gist will be generated.
+
+## License
+
+Copyright 2013 Scott González. Released under the terms of the MIT license.
Please sign in to comment.
Something went wrong with that request. Please try again.