/crates/regex/README.md

https://github.com/BurntSushi/ripgrep · Markdown · 35 lines · 25 code · 10 blank · 0 comment · 0 complexity · d52ee74252c75c0d71411436001f1a34 MD5 · raw file

  1. grep-regex
  2. ----------
  3. The `grep-regex` crate provides an implementation of the `Matcher` trait from
  4. the `grep-matcher` crate. This implementation permits Rust's regex engine to
  5. be used in the `grep` crate for fast line oriented searching.
  6. [![Linux build status](https://api.travis-ci.org/BurntSushi/ripgrep.svg)](https://travis-ci.org/BurntSushi/ripgrep)
  7. [![Windows build status](https://ci.appveyor.com/api/projects/status/github/BurntSushi/ripgrep?svg=true)](https://ci.appveyor.com/project/BurntSushi/ripgrep)
  8. [![](https://img.shields.io/crates/v/grep-regex.svg)](https://crates.io/crates/grep-regex)
  9. Dual-licensed under MIT or the [UNLICENSE](http://unlicense.org).
  10. ### Documentation
  11. [https://docs.rs/grep-regex](https://docs.rs/grep-regex)
  12. **NOTE:** You probably don't want to use this crate directly. Instead, you
  13. should prefer the facade defined in the
  14. [`grep`](https://docs.rs/grep)
  15. crate.
  16. ### Usage
  17. Add this to your `Cargo.toml`:
  18. ```toml
  19. [dependencies]
  20. grep-regex = "0.1"
  21. ```
  22. and this to your crate root:
  23. ```rust
  24. extern crate grep_regex;
  25. ```