fancier readme

This commit is contained in:
Christoph J. Scherr 2024-02-21 23:05:33 +01:00
parent e80f2cd2d0
commit fcc8ae076d
Signed by: PlexSheep
GPG Key ID: 7CDD0B14851A08EF
2 changed files with 11 additions and 1 deletions

View File

@ -1,6 +1,6 @@
[package]
name = "seep"
version = "0.1.0"
version = "0.1.1"
edition = "2021"
publish = true
authors = ["Christoph J. Scherr <software@cscherr.de>"]

View File

@ -1,10 +1,20 @@
# seep
![Project badge](https://img.shields.io/badge/language-Rust-blue.svg)
![Crates.io License](https://img.shields.io/crates/l/seep)
![Gitea Release](https://img.shields.io/gitea/v/release/PlexSheep/seep?gitea_url=https%3A%2F%2Fgit.cscherr.de)
![Gitea language count](https://img.shields.io/gitea/languages/count/PlexSheep/seep?gitea_url=https%3A%2F%2Fgit.cscherr.de)
[![cargo checks and tests](https://github.com/PlexSheep/seep/actions/workflows/cargo.yaml/badge.svg)](https://github.com/PlexSheep/seep/actions/workflows/cargo.yaml)
Print `stdin` to terminal, then pipe into next process.
`seep` (short for see pipe and also to describe leaks in real pipes) has the
purpose of letting you peek at what you're piping.
* [Original Repository](https://git.cscherr.de/PlexSheep/seep)
* [GitHub Mirror](https://github.com/PlexSheep/seep)
* [crates.io](https://crates.io/crates/seep)
## Usage
On Unix like systems, you can pass the output (`stdout`) of one process to the