/crates/grep/README.md

https://github.com/BurntSushi/ripgrep · Markdown · 41 lines · 26 code · 15 blank · 0 comment · 0 complexity · 78299e0615d0a46c97268566a22b9dfa MD5 · raw file 

    

  1. grep
    2. 

  2. ----
    3. 

  3. ripgrep, as a library.
    4. 

  4. 

  5. [![Linux build status](https://api.travis-ci.org/BurntSushi/ripgrep.svg)](https://travis-ci.org/BurntSushi/ripgrep)
    6. 

  6. [![Windows build status](https://ci.appveyor.com/api/projects/status/github/BurntSushi/ripgrep?svg=true)](https://ci.appveyor.com/project/BurntSushi/ripgrep)
    7. 

  7. [![](https://img.shields.io/crates/v/grep.svg)](https://crates.io/crates/grep)
    8. 

  8. 

  9. Dual-licensed under MIT or the [UNLICENSE](http://unlicense.org).
    10. 

  10. 

  11. 

  12. ### Documentation
    13. 

  13. 

  14. [https://docs.rs/grep](https://docs.rs/grep)
    15. 

  15. 

  16. NOTE: This crate isn't ready for wide use yet. Ambitious individuals can
    17. 

  17. probably piece together the parts, but there is no high level documentation
    18. 

  18. describing how all of the pieces fit together.
    19. 

  19. 

  20. 

  21. ### Usage
    22. 

  22. 

  23. Add this to your `Cargo.toml`:
    24. 

  24. 

  25. ```toml
    26. 

  26. [dependencies]
    27. 

  27. grep = "0.2"
    28. 

  28. ```
    29. 

  29. 

  30. and this to your crate root:
    31. 

  31. 

  32. ```rust
    33. 

  33. extern crate grep;
    34. 

  34. ```
    35. 

  35. 

  36. 

  37. ### Features
    38. 

  38. 

  39. This crate provides a `pcre2` feature (disabled by default) which, when
    40. 

  40. enabled, re-exports the `grep-pcre2` crate as an alternative `Matcher`
    41. 

  41. implementation to the standard `grep-regex` implementation.
    42.