From 80361f21cb1a8243c630312373e373b73e230349 Mon Sep 17 00:00:00 2001 From: John Hawthorn Date: Tue, 19 Apr 2016 16:50:22 -0700 Subject: Update README --- README.md | 33 ++++++++++++++++++++++++++------- 1 file changed, 26 insertions(+), 7 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 6e32749..fb36930 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,35 @@ # fzy -A fuzzy text selector for terminals in C inspired by -[selecta](https://github.com/garybernhardt/selecta), -but with an improved [scoring algorithm](#sorting). +A fast, simple fuzzy text selector for the terminal with an advanced [scoring +algorithm](#sorting). ![](http://i.hawth.ca/u/fzy2.gif) -> It's been kind of life-changing. -> -[@graygilmore](https://github.com/graygilmore/) +
+It's been kind of life-changing. +-@graygilmore +
-> fzy works great btw -> -[@alexblackie](https://twitter.com/alexblackie/status/719297828892188672) +
+fzy works great btw +-@alexblackie +
+ +[![Build Status](https://travis-ci.org/jhawthorn/fzy.svg?branch=master)](https://travis-ci.org/jhawthorn/fzy) + +## Why use this over fzf, pick, selecta, ctrlp, ...? + +fzy is faster and shows better results than other fuzzy finders. + +Most other fuzzy matchers sort based on the length of a match. fzy tries to +find the result the user intended. It does this by favouring matches on +consecutive letters and starts of words. This allows matching using acronyms or +different parts of the path. + +A gory comparison of the sorting used by fuzzy finders can be found in [ALGORITHM.md](ALGORITHM.md) + +fzy is designed to be used both as an editor plugin and on the command line. +Rather than clearing the screen, fzy displays its interface directly below the current cursor position, scrolling the screen if necessary. ## Installation -- cgit v1.2.3