diff options
author | Andrew Gallant <jamslam@gmail.com> | 2016-12-12 07:03:37 -0500 |
---|---|---|
committer | Andrew Gallant <jamslam@gmail.com> | 2016-12-12 07:03:37 -0500 |
commit | 8396d3ffaae3784880a6cef25775ba2abd9f4fcf (patch) | |
tree | 89773e783cd53e894ed0bb4fd88ac7b2193cd8ac /README.md | |
parent | 652c70f207ccfd859055c0bde09cbd6cc4a3d263 (diff) |
Make backreference support clear.
Fixes #268.
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 14 |
1 files changed, 10 insertions, 4 deletions
@@ -1,9 +1,15 @@ ripgrep (rg) ------------ -`ripgrep` is a command line search tool that combines the usability of The -Silver Searcher (an `ack` clone) with the raw speed of GNU grep. `ripgrep` has -first class support on Windows, Mac and Linux, with binary downloads available -for [every release](https://github.com/BurntSushi/ripgrep/releases). +`ripgrep` is a line oriented search tool that combines the usability of The +Silver Searcher (an `ack` clone) with the raw speed of GNU grep. `ripgrep` +works by recursively searching your current directory for a regex pattern. +`ripgrep` has first class support on Windows, Mac and Linux, with binary +downloads available for +[every release](https://github.com/BurntSushi/ripgrep/releases). + +ripgrep's regex engine uses finite automata and guarantees linear time +searching. Because of this, features like backreferences and arbitrary +lookaround are not supported. [![Linux build status](https://travis-ci.org/BurntSushi/ripgrep.svg?branch=master)](https://travis-ci.org/BurntSushi/ripgrep) [![Windows build status](https://ci.appveyor.com/api/projects/status/github/BurntSushi/ripgrep?svg=true)](https://ci.appveyor.com/project/BurntSushi/ripgrep) |