/crates/printer/README.md

https://github.com/BurntSushi/ripgrep · Markdown · 35 lines · 24 code · 11 blank · 0 comment · 0 complexity · f072d4f9db905f16c634414159177200 MD5 · raw file 

    

  1. grep-printer
    2. 

  2. ------------
    3. 

  3. Print results from line oriented searching in a human readable, aggregate or
    4. 

  4. JSON Lines format.
    5. 

  5. 

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

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

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

  9. 

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

  11. 

  12. ### Documentation
    13. 

  13. 

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

  15. 

  16. **NOTE:** You probably don't want to use this crate directly. Instead, you
    17. 

  17. should prefer the facade defined in the
    18. 

  18. [`grep`](https://docs.rs/grep)
    19. 

  19. crate.
    20. 

  20. 

  21. 

  22. ### Usage
    23. 

  23. 

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

  25. 

  26. ```toml
    27. 

  27. [dependencies]
    28. 

  28. grep-printer = "0.1"
    29. 

  29. ```
    30. 

  30. 

  31. and this to your crate root:
    32. 

  32. 

  33. ```rust
    34. 

  34. extern crate grep_printer;
    35. 

  35. ```
    36.