aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorRahiel Kasim <rahielkasim@gmail.com>2016-07-28 17:30:48 +0200
committerRahiel Kasim <rahielkasim@gmail.com>2016-07-28 17:30:48 +0200
commita8545b0feb980aacc492b7c2e3fac12568f8e441 (patch)
tree5299b31fc8ad91362fee8a98fb23025768594927
parentfe4c5815f99d8cc21595c48817b6e9c55b2c3bb2 (diff)
README: badges and references section
-rw-r--r--README.md24
1 files changed, 23 insertions, 1 deletions
diff --git a/README.md b/README.md
index 13c657f..296a3eb 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,15 @@
# pwds
+[![Version](https://img.shields.io/crates/v/pwds.svg)](https://crates.io/crates/pwds)
+[![Build Status](https://travis-ci.org/rahiel/pwds.svg?branch=master)](https://travis-ci.org/rahiel/pwds)
+[![License](https://img.shields.io/crates/l/pwds.svg)](https://github.com/rahiel/pwds/blob/master/LICENSE.txt)
+[![Downloads](https://img.shields.io/crates/d/pwds.svg)](https://crates.io/crates/pwds)
+
**P**rint the path of the current **w**orking **d**irectory, **s**hortly.
The current working directory in your prompt can get uncomfortably large,
leaving little space to type your own commands. With pwds paths like
-`~/Code/rust/src/doc/nomicon` are displayed as `~/C/r/s/d/nomicon`.
+`/home/user/Code/rust/src/doc/nomicon` are displayed as `~/C/r/s/d/nomicon`.
# Installation
@@ -34,3 +39,20 @@ the `PWDS_LENGTH` environment variable:
export PWDS_LENGTH=10
```
The current (most right) directory is never shortened.
+
+# References
+
+The concept of `pwds` is from [fish shell][fish], which provides this behaviour
+out of the box (with the [`prompt_pwd`][prompt_pwd] function). If you're not
+bound to your current shell, try the ergonomic and user-friendly shell today:
+[`><>`][fish].
+
+* [Bash prompts](https://sanctum.geek.nz/arabesque/bash-prompts/)
+* [Alternative prompt directory shortening for Bash](https://sanctum.geek.nz/arabesque/prompt-directory-shortening/)
+* [xonsh shell](http://xon.sh/), another shell with `pwds` like prompt path
+ shortening by default.
+* [pwds.py][]: Python version of `pwds`.
+
+[fish]: https://fishshell.com
+[prompt_pwd]: https://github.com/fish-shell/fish-shell/blob/master/share/functions/prompt_pwd.fish
+[pwds.py]: https://gist.github.com/rahiel/cdfda857534bc9dd4456e404a996e38f