Skip to content

Commit

Permalink
v1.0.0 update readme
Browse files Browse the repository at this point in the history
Let's make it version 1, it's now stable enough.
  • Loading branch information
benjajaja committed Mar 31, 2024
1 parent a940c4a commit 41ae96a
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 9 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "ratatui-image"
version = "0.10.0"
version = "1.0.0"
edition = "2021"
autoexamples = true
authors = ["Benjamin Große <ste3ls@gmail.com>"]
Expand Down
1 change: 1 addition & 0 deletions Makefile.toml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ dependencies = [
"test",
"readme",
"build",
"screenshot-ci",
]

[tasks.fmt]
Expand Down
11 changes: 4 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,18 +110,17 @@ blocking the UI thread.
The lib also includes a binary that renders an image file.

## Features
* `sixel` (default) compiles with libsixel.
* `rustix` (default) enables much better guessing of graphics protocols with `rustix::termios::tcgetattr`.
* `crossterm` or `termion` should match your ratatui backend. `termwiz` is available, but does not
work correctly with ratatu-image.
* `crossterm` or `termion` should match your ratatui backend. `termwiz` is available, but not
working correctly with ratatu-image.
* `serde` for `#[derive]`s on [picker::ProtocolType] for convenience, because it might be
useful to save it in some user configuration.
* `image-defaults` (default) just enables `image/defaults` (`image` has `default-features =
false`). To only support a selection of image formats and cut down dependencies, disable this
feature, add `image` to your crate, and enable its features/formats as desired. See
https://doc.rust-lang.org/cargo/reference/features.html#feature-unification.

The sixel implementation is now native: [icy_sixel](https://github.com/mkrueger/icy_sixel).

[Ratatui]: https://github.com/ratatui-org/ratatui
[Sixel]: https://en.wikipedia.org/wiki/Sixel
[`render_stateful_widget`]: https://docs.rs/ratatui/latest/ratatui/terminal/struct.Frame.html#method.render_stateful_widget
Expand All @@ -132,7 +131,7 @@ Compatibility and QA:

Terminal | Protocol | Fixed | Resize | Notes
----------|----------|-------|--------|-------
Xterm | `Sixel` | ✔️ | ✔️ | Run with `-ti 340` to make sure sixel support is enabled. [Latest Xvfb test screenshot](./assets/screenshot_xterm.png).
Xterm | `Sixel` | ✔️ | ✔️ | Run with `-ti 340` to make sure sixel support is enabled.
Foot | `Sixel` | ✔️ | ✔️ | Wayland.
kitty | `Kitty` | ✔️ | ✔️ |
Wezterm | `iTerm2` | ✔️ | ✔️ | Also would support `Sixel` and `Kitty`, but only `iTerm2` actually works bug-free.
Expand All @@ -145,8 +144,6 @@ Blackbox | `Sixel` | ❔ | ❔ | Untested.

Here, "Fixed" means the `Image` widget, and "Resize" is the `StatefulWidget`.

A basic screenshot test is run with xterm on Xvfb in the CI (or `cargo make screenshot-xvfb && cargo make screenshot-diff`).

Halfblocks should work in all terminals.

### Comparison:
Expand Down

0 comments on commit 41ae96a

Please sign in to comment.