Skip to content

Commit 20e7b3e

Browse files
committed
Update README.md
1 parent 1a01b38 commit 20e7b3e

File tree

1 file changed

+43
-16
lines changed

1 file changed

+43
-16
lines changed

README.md

Lines changed: 43 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,58 @@
22

33
> k is the new l, yo
44
5-
## Repos
5+
k is a zsh script to make directory listings more readable, adding a bit of color and some git information.
66

7-
Turns boring direcory listing of your git repos from this:
7+
## Repo markers on directory listings
8+
Red for dirty, green for committed.
9+
10+
Turns this:
811
![repos-ls](https://raw.githubusercontent.com/supercrabtree/k/gh-pages/repos-ls.jpg)
912

10-
Into this:
11-
![repos-ls](https://raw.githubusercontent.com/supercrabtree/k/gh-pages/repos-k.jpg)
13+
Into this:
14+
![repos-k](https://raw.githubusercontent.com/supercrabtree/k/gh-pages/repos-k.jpg)
1215

13-
### Usage
14-
hit k, just like you would l (or ls)
16+
## Git status on files with a working tree
17+
Red for dirty, green for committed, orange for untracked, grey for ingored.
18+
19+
Turns this:
20+
![status-ls](https://raw.githubusercontent.com/supercrabtree/k/gh-pages/status-ls.jpg)
21+
22+
Into this:
23+
![status-k](https://raw.githubusercontent.com/supercrabtree/k/gh-pages/status-k.jpg)
24+
25+
## File weight colours
26+
Files sizes are graded from green for small (< 1k), to red for huge (> 1mb).
27+
28+
Turns this:
29+
![status-ls](https://raw.githubusercontent.com/supercrabtree/k/gh-pages/size-ls.jpg)
30+
31+
Into this:
32+
![status-k](https://raw.githubusercontent.com/supercrabtree/k/gh-pages/size-k.jpg)
1533

16-
```shell
17-
k
18-
```
1934

20-
### Installation
35+
## Usage
2136
Put `k.sh` somewhere, and source it in your `.zshrc`.
2237

2338
```shell
2439
source ~/path-to/k/k.sh
2540
```
2641

27-
### Thanks
28-
ZSH Team
29-
BSD Team
30-
[Robby Russell](https://github.com/robbyrussell) for making the shell fun with oh my zsh
31-
[Sindre Sorhus](https://github.com/sindresorhus) for fast git commands from Z pure theme
32-
[Rupa](https://github.com/rupa/z) for that slammin' strapline
42+
hit k
43+
44+
```shell
45+
k
46+
```
47+
48+
profit
49+
50+
## Thanks
51+
zsh Team
52+
[Robby Russell](https://github.com/robbyrussell) for making the shell fun with oh my zsh
53+
[Sindre Sorhus](https://github.com/sindresorhus) for fast git commands from zsh pure theme
54+
[Rupa](https://github.com/rupa/z) for that slammin' strapline
55+
56+
## Contributing
57+
Pull requests welcome.
58+
59+
MIT License

0 commit comments

Comments
 (0)