Skip to content

Commit

Permalink
add project description and usage
Browse files Browse the repository at this point in the history
  • Loading branch information
halyna-dev committed Nov 29, 2020
1 parent 38a641c commit 3186870
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,21 @@
# niceDiff
Get difference beetwine two branches or file into readeble HTML file.
:star:**niceDiff**:star: helps to get the difference between two branches in a readable html file.
![](niceDiff.gif)

#### How to use
1. Clone this repo
```
git clone https://github.com/halyna-dev/niceDiff.git
```
2. Add niceDiff folder to your PATH variable. Don't forget reload your machine or logout/login from your windows account.
3. Run niceDiff command from your git repo
```
niceDiff <branch1-name> <branch2-name> [optional <path-to-comparing-files>]
```
4. Open file in the your folder with git repo
```
niceDiff-report.html
```

#### How it works
niceDiff is based on the standard git diff command. Magic is in batch parsing result. parseDiff.bat gets standard git diff output and tries to parse line by line.
Binary file added niceDiff.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3186870

Please sign in to comment.