Skip to content

Commit

Permalink
Merge pull request #171 from mihaigalos/docs/improve
Browse files Browse the repository at this point in the history
docs: Improve
  • Loading branch information
mihaigalos authored May 22, 2024
2 parents df6be25 + 64fd9ea commit 39e5eac
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[package]
edition = "2021"
name = "pipeview"
version = "0.2.3"
version = "0.2.4"
description = "🧪 A command line pipe inspection utility."
categories = ["command-line-utilities", "visualization"]
keywords = ["pipe", "meter", "gauge"]
Expand Down
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,18 @@ A command line pipe inspection utility.

## Usage

### Simple coloring with no args
When calling pipeview with no parameters, it will search for commas in the input. If no commas are found, it will default to searching for spaces.

Whichever it finds first will serve as a delimiter for splitting the input for coloring.

Example:
```bash
$ cat ~/.ssh/id_rsa.pub | pipeview
```
![Screenshot 2024-05-22 at 18 07 07](https://github.com/mihaigalos/pipeview/assets/16443090/00de2004-f37b-42b4-a7a9-3abdcd288ed7)

### Explicit coloring via regex patterns
Explicit coloring can be performed on the input based on a regular expression.

```bash
Expand Down

0 comments on commit 39e5eac

Please sign in to comment.