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 d97fb72d84
doc: update CI links in crate READMEs
I switched to GitHub Actions long ago, which replaces both Travis and
AppVeyor.

Fixes #1732
2020-11-16 19:07:16 -05:00

938 B

grep

ripgrep, as a library.

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.