Skip to content

Commit 1e4df29

Browse files
Prettify the README with some emojis
1 parent 31895dc commit 1e4df29

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
# diff-so-fancy [![Circle CI build](https://circleci.com/gh/so-fancy/diff-so-fancy.svg?style=shield)](https://circleci.com/gh/so-fancy/diff-so-fancy) [![TravisCI build](https://travis-ci.org/so-fancy/diff-so-fancy.svg?branch=master)](https://travis-ci.org/so-fancy/diff-so-fancy) [![AppVeyor build](https://ci.appveyor.com/api/projects/status/github/so-fancy/diff-so-fancy?branch=master&svg=true)](https://ci.appveyor.com/project/stevemao/diff-so-fancy/branch/master)
1+
# 🕶️ diff-so-fancy [![Circle CI build](https://circleci.com/gh/so-fancy/diff-so-fancy.svg?style=shield)](https://circleci.com/gh/so-fancy/diff-so-fancy) [![TravisCI build](https://travis-ci.org/so-fancy/diff-so-fancy.svg?branch=master)](https://travis-ci.org/so-fancy/diff-so-fancy) [![AppVeyor build](https://ci.appveyor.com/api/projects/status/github/so-fancy/diff-so-fancy?branch=master&svg=true)](https://ci.appveyor.com/project/stevemao/diff-so-fancy/branch/master)
22

33
`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.
44

5-
## Screenshot
5+
## 🖼️ Screenshot
66

77
Vanilla `git diff` vs `git` and `diff-so-fancy`
88

99
![diff-highlight vs diff-so-fancy](diff-so-fancy.png)
1010

11-
## Install
11+
## 📦 Install
1212

1313
Simply copy the `diff-so-fancy` script from the latest release into your `$PATH` and you're done. Alternately to test development features you can clone this repo and then put the `diff-so-fancy` script (symlink will work) into your `$PATH`. The `lib/` directory will need to be kept relative to the core script.
1414

@@ -20,7 +20,7 @@ Issues relating to packaging ("installation does not work", "version is out of d
2020

2121
**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).
2222

23-
## Usage
23+
## Usage
2424

2525
### With git
2626

@@ -69,7 +69,7 @@ diff -r -u folder_a folder_b | diff-so-fancy
6969
```shell
7070
diff --recursive -u folder_a folder_b | diff-so-fancy
7171
```
72-
## Options
72+
## ⚒️ Options
7373

7474
### markEmptyLines
7575

@@ -111,7 +111,7 @@ By default, the separator for the file header spans the full width of the termin
111111
git config --global diff-so-fancy.rulerWidth 80
112112
```
113113

114-
## The diff-so-fancy team
114+
## 👨 The diff-so-fancy team
115115

116116
| Person | Role |
117117
| --------------------- | ---------------- |
@@ -121,7 +121,7 @@ git config --global diff-so-fancy.rulerWidth 80
121121
| @AOS | Debian packager |
122122
| @Stevemao/@Paul Irish | NPM release team |
123123

124-
## Contributing
124+
## 🧬 Contributing
125125

126126
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*.
127127

@@ -132,11 +132,11 @@ Pull requests are quite welcome, and should target the [`next` branch](https://g
132132
* [Hacking and Testing](hacking-and-testing.md)
133133
* [History](history.md)
134134

135-
## Alternatives
135+
## 🔃 Alternatives
136136

137137
* [Delta](https://github.com/dandavison/delta)
138138
* [Lazygit](https://github.com/jesseduffield/lazygit) with diff-so-fancy [integration](https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md#diff-so-fancy)
139139

140-
## License
140+
## 🏛️ License
141141

142142
MIT

0 commit comments

Comments
 (0)