From 59fc583aebf81d757a4477b4fec8510221afaa3d Mon Sep 17 00:00:00 2001 From: Andrew Gallant Date: Wed, 27 Feb 2019 08:01:23 -0500 Subject: [PATCH] readme: include details about filtering Despite the fact that we mention this in several places, people are still surprised by ripgrep's "smart" filtering. --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2016ce03..3ea0d3c7 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,12 @@ ripgrep (rg) ------------ ripgrep is a line-oriented search tool that recursively searches your current -directory for a regex pattern while respecting your gitignore rules. ripgrep +directory for a regex pattern. By default, ripgrep will respect your .gitignore +and automatically skip hidden files/directories and binary files. ripgrep has first class support on Windows, macOS and Linux, with binary downloads available for [every release](https://github.com/BurntSushi/ripgrep/releases). -ripgrep is similar to other popular search tools like The Silver Searcher, -ack and grep. +ripgrep is similar to other popular search tools like The Silver Searcher, ack +and grep. [![Linux build status](https://travis-ci.org/BurntSushi/ripgrep.svg)](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)