1
0
mirror of https://github.com/BurntSushi/ripgrep.git synced 2024-12-12 19:18:24 +02:00
ripgrep/crates/grep/README.md
Andrew Gallant fdd8510fdd repo: move all source code in crates directory
The top-level listing was just getting a bit too long for my taste. So
put all of the code in one directory and shrink the large top-level mess
to a small top-level mess.

NOTE: This commit only contains renames. The subsequent commit will
actually make ripgrep build again. We do it this way with the naive hope
that this will make it easier for git history to track the renames.
Sigh.
2020-02-17 19:24:53 -05:00

1.1 KiB

grep

ripgrep, as a library.

Linux build status Windows build status

Dual-licensed under MIT or the UNLICENSE.

Documentation

https://docs.rs/grep

NOTE: This crate isn't ready for wide use yet. Ambitious individuals can probably piece together the parts, but there is no high level documentation describing how all of the pieces fit together.

Usage

Add this to your Cargo.toml:

[dependencies]
grep = "0.2"

and this to your crate root:

extern crate grep;

Features

This crate provides a pcre2 feature (disabled by default) which, when enabled, re-exports the grep-pcre2 crate as an alternative Matcher implementation to the standard grep-regex implementation.