1
0
mirror of https://github.com/BurntSushi/ripgrep.git synced 2025-08-05 06:32:04 -07:00
Files
.cargo
.github
benchsuite
ci
complete
crates
cli
core
globset
grep
examples
src
COPYING
Cargo.toml
LICENSE-MIT
README.md
UNLICENSE
ignore
matcher
pcre2
printer
regex
searcher
doc
pkg
scripts
tests
.gitignore
.ignore
CHANGELOG.md
COPYING
Cargo.lock
Cargo.toml
Cross.toml
FAQ.md
GUIDE.md
LICENSE-MIT
README.md
RELEASE-CHECKLIST.md
UNLICENSE
build.rs
rustfmt.toml
ripgrep/crates/grep/README.md
Andrew Gallant e824531e38 edition: manual changes
This is mostly just about removing 'extern crate' everywhere and fixing
the fallout.
2021-06-01 21:07:37 -04:00

35 lines
876 B
Markdown

grep
----
ripgrep, as a library.
[![Build status](https://github.com/BurntSushi/ripgrep/workflows/ci/badge.svg)](https://github.com/BurntSushi/ripgrep/actions)
[![](https://img.shields.io/crates/v/grep.svg)](https://crates.io/crates/grep)
Dual-licensed under MIT or the [UNLICENSE](https://unlicense.org/).
### Documentation
[https://docs.rs/grep](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`:
```toml
[dependencies]
grep = "0.2"
```
### 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.