Skip to content

Commit 0f61fce

Browse files
Update README.md
1 parent eb12d3f commit 0f61fce

1 file changed

Lines changed: 43 additions & 0 deletions

File tree

README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,35 @@ Read from stdin:
4545
cat photo.jpg | asimov-image-reader
4646
```
4747

48+
Pipe the reader into the viewer (Linux/macOS):
49+
```bash
50+
# Show a single image
51+
asimov-image-reader ./photo.jpg | asimov-image-viewer
52+
53+
# Resize before viewing
54+
asimov-image-reader ./photo.jpg --size 800x600 | asimov-image-viewer
55+
```
56+
57+
Pipe on Windows (PowerShell):
58+
```powershell
59+
asimov-image-reader .\photo.jpg | asimov-image-viewer
60+
```
61+
62+
Tee the stream (debug pipelines) while viewing:
63+
```bash
64+
asimov-image-reader ./photo.jpg | asimov-image-viewer --union | jq .
65+
```
66+
67+
View a sequence (any producer that emits one Image JSON per line will work):
68+
```bash
69+
# Example: loop multiple files through the reader into the viewer
70+
for f in imgs/*.jpg; do asimov-image-reader "$f"; done | asimov-image-viewer
71+
```
72+
73+
> Notes
74+
> - The viewer auto-updates on each incoming frame and resizes the framebuffer to match the image.
75+
> - The viewer expects RGB byte data (R, G, B per pixel) packed in data and width/height set.
76+
4877
## ⚙ Configuration
4978

5079
This module requires no configuration.
@@ -54,6 +83,7 @@ This module requires no configuration.
5483
### Installed Binaries
5584

5685
- `asimov-image-reader` — reads and emits image metadata as JSON-LD
86+
- `asimov-image-viewer` — displays image JSON frames in a window
5787

5888
### `asimov-image-reader`
5989

@@ -68,6 +98,19 @@ Options:
6898
-h, --help Print help
6999
```
70100

101+
### `asimov-image-viewer`
102+
103+
```
104+
Usage: asimov-image-viewer [OPTIONS]
105+
106+
Options:
107+
-U, --union Copy stdin to stdout (tee)
108+
--license Show license information
109+
-v, --verbose Enable verbose output
110+
-V, --version Print version information
111+
-h, --help Print help
112+
```
113+
71114
## 👨‍💻 Development
72115

73116
```bash

0 commit comments

Comments
 (0)