/crates/searcher/README.md

https://github.com/BurntSushi/ripgrep · Markdown · 37 lines · 26 code · 11 blank · 0 comment · 0 complexity · b4e7768be826b93698d759c5545dced4 MD5 · raw file

  1. grep-searcher
  2. -------------
  3. A high level library for executing fast line oriented searches. This handles
  4. things like reporting contextual lines, counting lines, inverting a search,
  5. detecting binary data, automatic UTF-16 transcoding and deciding whether or not
  6. to use memory maps.
  7. [![Linux build status](https://api.travis-ci.org/BurntSushi/ripgrep.svg)](https://travis-ci.org/BurntSushi/ripgrep)
  8. [![Windows build status](https://ci.appveyor.com/api/projects/status/github/BurntSushi/ripgrep?svg=true)](https://ci.appveyor.com/project/BurntSushi/ripgrep)
  9. [![](https://img.shields.io/crates/v/grep-searcher.svg)](https://crates.io/crates/grep-searcher)
  10. Dual-licensed under MIT or the [UNLICENSE](http://unlicense.org).
  11. ### Documentation
  12. [https://docs.rs/grep-searcher](https://docs.rs/grep-searcher)
  13. **NOTE:** You probably don't want to use this crate directly. Instead, you
  14. should prefer the facade defined in the
  15. [`grep`](https://docs.rs/grep)
  16. crate.
  17. ### Usage
  18. Add this to your `Cargo.toml`:
  19. ```toml
  20. [dependencies]
  21. grep-searcher = "0.1"
  22. ```
  23. and this to your crate root:
  24. ```rust
  25. extern crate grep_searcher;
  26. ```