summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorAndrew Gallant <jamslam@gmail.com>2022-10-19 09:52:37 -0400
committerAndrew Gallant <jamslam@gmail.com>2022-10-19 09:52:37 -0400
commit5b2f614aad9eba487e49bbf8be22e86337de6622 (patch)
treeb078ab22c304495745a9b5a5b5dbc39749389796 /README.md
parent4386b8e805e273a9795ad4e256c455c74407c949 (diff)
readme: add note about 'rg -uuu'
I'm not sure about putting this in such a prominent spot, and it does bloat the introductory paragraph a bit, but it seems like an important special case.
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/README.md b/README.md
index 3a1ed02a..b2f7dbb8 100644
--- a/README.md
+++ b/README.md
@@ -2,11 +2,11 @@ ripgrep (rg)
------------
ripgrep is a line-oriented search tool that recursively searches the current
directory for a regex pattern. By default, ripgrep will respect gitignore rules
-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.
+and automatically skip hidden files/directories and binary files. (To disable
+all automatic filtering by default, use `rg -uuu`.) 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.
[![Build status](https://github.com/BurntSushi/ripgrep/workflows/ci/badge.svg)](https://github.com/BurntSushi/ripgrep/actions)
[![Crates.io](https://img.shields.io/crates/v/ripgrep.svg)](https://crates.io/crates/ripgrep)