Skip to content
This repository was archived by the owner on Jun 8, 2020. It is now read-only.

Commit fe04608

Browse files
committed
--: Better README.
1 parent a8ebcfe commit fe04608

File tree

2 files changed

+13
-5
lines changed

2 files changed

+13
-5
lines changed

.gitattributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*.svg filter=lfs diff=lfs merge=lfs -text

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
11
# ls-git
2-
A git-aware drop-in replacement for `ls`.
2+
Do you find it annoying/verbose to figure out the state of your git repositories when using a terminal?
3+
If so, then `ls-git` is here to come to your rescue!
4+
5+
Designed to be a **fast** and effective union of `ls` and `git status`, this script allows you to see the state
6+
of files and directories in your repository in way that is both familiar and useful.
37

48
<p align="center">
5-
<img src="https://media.githubusercontent.com/media/eth-p/ls-git/master/docs/demo.svg">
9+
<img src="https://media.githubusercontent.com/media/eth-p/ls-git/a56c69119cdd4051d73629aaef9e0bb5d07b78f5/docs/demo.svg">
610
</p>
711

812
## Compatibility
9-
As far as it's implemented right now, it should work for most use cases.
10-
See [here](https://github.com/eth-p/ls-git/issues/1) for a full list of compatible flags.
13+
Due to the complexity of `ls`, not all command-line switches are supported.
14+
15+
See [here](https://github.com/eth-p/ls-git/issues/1) for a full compatibility list.
1116

1217
## Requirements
1318

@@ -18,5 +23,7 @@ See [here](https://github.com/eth-p/ls-git/issues/1) for a full list of compatib
1823
## Installation
1924

2025
```bash
21-
bash install
26+
git clone 'https://github.com/eth-p/ls-git.git'
27+
cd ls-git
28+
./install
2229
```

0 commit comments

Comments
 (0)