README.md
1# paragrep, a paragraph _grep_
2
3*paragrep* is a "paragraph grep" utility. It searches for a series of
4regular expressions in a text file (or several text files) and prints out
5the paragraphs containing those expressions. Normally paragrep displays a
6paragraph if it contains any of the expressions; this behavior can be
7modified by using the -a option.
8
9## Quick Start
10
11```
12$ pip install paragrep
13$ paragrep --help
14```
15
16**WARNING:** As of version 3.2.0, _paragrep_ no longer supports Python 2.
17If you need to run it under Python 2, use an older version. e.g.:
18
19```
20$ pip install paragrep==3.1.3
21```
22
23## Complete docs
24
25For all the docs, see the [project site](http://software.clapper.org/paragrep).
26