Skip to content

Commit e04039f

Browse files
committed
update README for iterm2 and bump version
1 parent 9dafa77 commit e04039f

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Better image component for [Ink](https://github.com/vadimdemedes/ink) CLI/TUI applications.
44

5-
Display images in your terminal with automatic protocol detection and graceful fallbacks. Supports ASCII, Braille patterns, Unicode half-blocks, and Sixel graphics.
5+
Display images in your terminal with automatic protocol detection and graceful fallbacks. Supports ASCII, Braille patterns, Unicode half-blocks, Sixel graphics, and iTerm2 inline images.
66

77
<img width="1919" height="765" alt="Screenshot 2025-09-07 160615" src="https://github.com/user-attachments/assets/0be5be69-043a-446a-aa8a-7d138919113c" />
88

@@ -58,7 +58,7 @@ Main component with automatic protocol detection and fallback.
5858
- `width?` (number) - Width in terminal cells
5959
- `height?` (number) - Height in terminal cells
6060
- `alt?` (string) - Alternative text for loading/error states
61-
- `protocol?` (string) - Force specific protocol: `"ascii"`, `"braille"`, `"halfBlock"`, `"sixel"` (`sixel` is experimental, see [Important Notes](#important-notes--caveats))
61+
- `protocol?` (string) - Force specific protocol: `"ascii" | "braille" | "halfBlock" | "sixel" | "iterm2"` (`sixel` and `iterm2` are experimental, see [Important Notes](#important-notes--caveats))
6262

6363
#### Protocols
6464

@@ -68,6 +68,7 @@ The component automatically selects the best available protocol:
6868
2. **Braille** (`braille`) - High-resolution monochrome using Braille patterns. Requires Unicode support.
6969
3. **ASCII** (`ascii`) - Character-based art. Works in all terminals (fallback).
7070
4. **Sixel** (`sixel`) - True color bitmap graphics. Requires Sixel support (experimental).
71+
5. **iTerm2** (`iterm2`) - True color images in iTerm2-compatible terminals (experimental).
7172

7273
### `<TerminalInfoProvider>`
7374

@@ -87,6 +88,7 @@ import {
8788
BrailleImage,
8889
HalfBlockImage,
8990
SixelImage,
91+
Iterm2Image,
9092
} from "ink-picture";
9193
```
9294

@@ -98,11 +100,11 @@ import {
98100

99101
## Important Notes & Caveats
100102

101-
### Sixel Renderer (Experimental)
103+
### Sixel and iTerm2 Renderers (Experimental)
102104

103-
The Sixel renderer provides the highest quality but comes with important limitations:
105+
The Sixel and iTerm2 renderers provide the highest quality but come with important limitations:
104106

105-
⚠️ **Experimental Warning:** The Sixel component bypasses React/Ink's normal rendering pipeline and writes directly to the terminal. You may experience:
107+
⚠️ **Experimental Warning:** These components bypasses React/Ink's normal rendering pipeline and writes directly to the terminal. You may experience:
106108

107109
- Rendering flicker during updates
108110
- Cursor positioning issues

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "ink-picture",
3-
"version": "1.1.1",
3+
"version": "1.2.0",
44
"description": "Better image component for Ink CLI/TUIs",
55
"license": "MIT",
66
"repository": "https://github.com/endernoke/ink-picture",

0 commit comments

Comments
 (0)