/crates/cli/README.md

https://github.com/BurntSushi/ripgrep · Markdown · 38 lines · 26 code · 12 blank · 0 comment · 0 complexity · 521c127e22f130af8bf35e711e0b4ebf MD5 · raw file

  1. grep-cli
  2. --------
  3. A utility library that provides common routines desired in search oriented
  4. command line applications. This includes, but is not limited to, parsing hex
  5. escapes, detecting whether stdin is readable and more. To the extent possible,
  6. this crate strives for compatibility across Windows, macOS and Linux.
  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-cli.svg)](https://crates.io/crates/grep-cli)
  10. Dual-licensed under MIT or the [UNLICENSE](http://unlicense.org).
  11. ### Documentation
  12. [https://docs.rs/grep-cli](https://docs.rs/grep-cli)
  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-cli = "0.1"
  22. ```
  23. and this to your crate root:
  24. ```rust
  25. extern crate grep_cli;
  26. ```