Browse code

Update README

John Hawthorn authored on 19/04/2016 23:50:22
Showing 1 changed files

... ...
@@ -1,16 +1,35 @@
1 1
 # fzy
2 2
 
3
-A fuzzy text selector for terminals in C inspired by
4
-[selecta](https://github.com/garybernhardt/selecta),
5
-but with an improved [scoring algorithm](#sorting).
3
+A fast, simple fuzzy text selector for the terminal with an advanced [scoring
4
+algorithm](#sorting).
6 5
 
7 6
 ![](http://i.hawth.ca/u/fzy2.gif)
8 7
 
9
-> It's been kind of life-changing.
10
-> -[@graygilmore](https://github.com/graygilmore/)
8
+<blockquote>
9
+It's been kind of life-changing.
10
+-<a href="https://github.com/graygilmore/">@graygilmore</a>
11
+</blockquote>
11 12
 
12
-> fzy works great btw
13
-> -[@alexblackie](https://twitter.com/alexblackie/status/719297828892188672)
13
+<blockquote>
14
+fzy works great btw
15
+-<a href="https://twitter.com/alexblackie/status/719297828892188672">@alexblackie</a>
16
+</blockquote>
17
+
18
+[![Build Status](https://travis-ci.org/jhawthorn/fzy.svg?branch=master)](https://travis-ci.org/jhawthorn/fzy)
19
+
20
+## Why use this over fzf, pick, selecta, ctrlp, ...?
21
+
22
+fzy is faster and shows better results than other fuzzy finders.
23
+
24
+Most other fuzzy matchers sort based on the length of a match. fzy tries to
25
+find the result the user intended. It does this by favouring matches on
26
+consecutive letters and starts of words. This allows matching using acronyms or
27
+different parts of the path.
28
+
29
+A gory comparison of the sorting used by fuzzy finders can be found in [ALGORITHM.md](ALGORITHM.md)
30
+
31
+fzy is designed to be used both as an editor plugin and on the command line.
32
+Rather than clearing the screen, fzy displays its interface directly below the current cursor position, scrolling the screen if necessary.
14 33
 
15 34
 ## Installation
16 35