Skip to content

Commit 8a3b3e9

Browse files
committed
docs: update supported image formats
1 parent 1b551b1 commit 8a3b3e9

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

Cargo.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
name = "gbc-image-transform"
33
version = "0.1.0"
44
edition = "2021"
5-
description = "Generate Game Boy Color lookalike images from a PNG image."
5+
description = "Generate Game Boy Color lookalike image from an image."
66

77
[dependencies]
88
# for easier error handling

README.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# gbc-image-transform
22

3-
A CLI to generate Game Boy Color lookalike images from a PNG image.
3+
A CLI to generate Game Boy Color lookalike images from an image.
44

55
The Game Boy Color can display any combination of 32,768 different colors (15-bit RGB), but at any given time, it can display only up to 56 different colors (ref.: [Game Boy Color - Wikipedia](https://en.wikipedia.org/wiki/Game_Boy_Color#Technical_specifications)).
66

@@ -39,6 +39,10 @@ Options:
3939
Print version
4040
```
4141

42+
### Supported Image Formats
43+
44+
The CLI should support any image format supported by the [image](https://crates.io/crates/image) crate, but tested with JPEG and PNG. The format is determined from the `path`'s file extension.
45+
4246
## License
4347

4448
MIT. See [LICENSE](LICENSE) for details.

0 commit comments

Comments
 (0)