From 16249da803f607d8d748aa162a908d7d38416ca8 Mon Sep 17 00:00:00 2001 From: Edgar HIPP Date: Sat, 16 Jan 2016 11:48:00 +0100 Subject: [PATCH] Reformat readme --- README.md | 55 ++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 36 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index a195c65..d6a2553 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,54 @@ -# PathExtractor (pe) +PathExtractor (pe) +================== -![demo](https://raw.github.com/edi9999/i/master/demo.gif) +![demo](https://raw.github.com/edi9999/i/master/demo.gif?v=2) PathExtractor is a command line tool that extracts a list of files/paths from stdin. Advantages over [fpp](https://github.com/facebook/PathPicker): - * It does only one thing : more unixy - * You can use it with any fuzzy finder, such as [fzf](https://github.com/junegunn/fzf),[peco](https://github.com/peco/peco),[percol](https://github.com/mooz/percol),[pick](https://github.com/thoughtbot/pick),[selecta](https://github.com/garybernhardt/selecta/) - * It doesn't wait for stdin to be finished to output the paths - * It is faster - * It is much smaller (easily understandable) - * You can also use it without a fuzzy finder for programmatic usage +- It does only one thing : more unixy +- You can use it with any fuzzy finder, such as [fzf](https://github.com/junegunn/fzf),[peco](https://github.com/peco/peco),[percol](https://github.com/mooz/percol),[pick](https://github.com/thoughtbot/pick),[selecta](https://github.com/garybernhardt/selecta/) +- It doesn't wait for stdin to be finished to output the paths +- It is faster +- It is much smaller (easily understandable) +- You can also use it without a fuzzy finder for programmatic usage For example, you could write: - git status | pe +``` +git status | pe +``` to get a list of the files that were added/changed, without all the formating One of the most common usage is to create an alias that will automatically run : - `pe` + a command line fuzzy finder such as fzf + an action such as opening that file in your favorite editor. +`pe` + a command line fuzzy finder such as fzf + an action such as opening that file in your favorite editor. For example, using `zsh` , I have as an alias: - alias -g P='| pe | fzf | read filename; [ ! -z $filename ] && vim $filename' +``` +alias -g P='| pe | fzf | read filename; [ ! -z $filename ] && vim $filename' +``` With `bash`: - bind '"PP": "| pe | uniq | fzf | while read filename; do [ ! -z $filename ] &&