]> Sergey Matveev's repositories - path-extractor.git/commitdiff
Reformat readme
authorEdgar HIPP <hipp.edg@gmail.com>
Sat, 16 Jan 2016 10:48:00 +0000 (11:48 +0100)
committerEdgar HIPP <hipp.edg@gmail.com>
Sat, 16 Jan 2016 10:48:00 +0000 (11:48 +0100)
README.md

index a195c65d75cd3703fc3ffe423f610553059d1459..d6a2553e8223d1feef233a44aa70edef88f1a5f0 100644 (file)
--- 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 ] && </dev/tty vim $filename; done\n'
+```
+bind '"PP": "| pe | uniq | fzf | while read filename; do [ ! -z $filename ] && </dev/tty vim $filename; done\n'
+```
 
 So that If I run
 
-    `git status P`
+```
+`git status P`
+```
 
 or
 
-    `git status PP`
+```
+`git status PP`
+```
 
 to quickly open one of the changed files in vim
 
@@ -45,14 +56,19 @@ Other usage ideas:
 
 With zsh:
 
-    # Copy selected path to clipboard
-    alias -g C='| pe | fzf | read filename; [ ! -z $filename ] && echo -n $filename | xclip -selection c'
+```
+# Copy selected path to clipboard
+alias -g C='| pe | fzf | read filename; [ ! -z $filename ] && echo -n $filename | xclip -selection c'
+```
 
 With bash:
 
-    bind '"CC": "| pe | fzf | read filename; [ ! -z $filename ] && echo -n $filename | xclip -selection c\n"'
+```
+bind '"CC": "| pe | fzf | read filename; [ ! -z $filename ] && echo -n $filename | xclip -selection c\n"'
+```
 
-# Installation
+Installation
+============
 
 ```
 go get github.com/edi9999/path-extractor/path-extractor
@@ -60,6 +76,7 @@ go get github.com/edi9999/path-extractor/path-extractor
 
 You will have the `path-extractor` in your `$GOPATH/bin` directory which you can rename or alias to `pe`
 
-# Binaries
+Binaries
+========
 
 They are no binaries for now (you have to build it yourself), but one idea would be to use [goxc](https://github.com/laher/goxc) to compile it on multiple platforms