diff options
Diffstat (limited to 'crates/grep/README.md')
| -rw-r--r-- | crates/grep/README.md | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/crates/grep/README.md b/crates/grep/README.md new file mode 100644 index 00000000..c376d8af --- /dev/null +++ b/crates/grep/README.md @@ -0,0 +1,41 @@ +grep +---- +ripgrep, as a library. + +[](https://travis-ci.org/BurntSushi/ripgrep) +[](https://ci.appveyor.com/project/BurntSushi/ripgrep) +[](https://crates.io/crates/grep) + +Dual-licensed under MIT or the [UNLICENSE](http://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" +``` + +and this to your crate root: + +```rust +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. |