Skip to content

Commit 125d2a6

Browse files
authored
Update README.md
1 parent 23385a5 commit 125d2a6

File tree

1 file changed

+33
-1
lines changed

1 file changed

+33
-1
lines changed

README.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,34 @@
11
# image-extras
2-
Decoding support for additional image formats
2+
Decoding support for additional image formats beyond those provided by the [`image`](https://crates.io/crates/image) crate.
3+
4+
## Supported formats
5+
6+
| Extension | File Format Description |
7+
| --------- | -------------------- |
8+
| PCX | [Wikipedia](https://en.wikipedia.org/wiki/PCX#PCX_file_format) |
9+
10+
## New Formats
11+
12+
We welcome PRs to add support for additional image formats.
13+
14+
#### Required criteria
15+
16+
- [ ] Must be one of the raster image formats recognized by [ImageMagick](https://imagemagick.org/script/formats.php).
17+
- [ ] No patent or licensing restrictions.
18+
- [ ] Specification or sufficiently detailed file format description freely available online.
19+
- [ ] Must include multiple test images with suitable licenses.
20+
- [ ] Implementation must be entirely in Rust.
21+
22+
#### Additional nice-to-haves
23+
24+
- [ ] Minimal or no dependencies on external libraries.
25+
- [ ] No use of unsafe code.
26+
27+
## Fuzzing
28+
29+
Fuzzing is not a priority for this crate and decoders may panic or worse on
30+
malformed input. Please do not open issues for crashes found by fuzzing, though
31+
PRs fixing them are welcome.
32+
33+
This is an intentional tradeoff to balance the inclusion criteria for new
34+
formats with maintainer time and effort.

0 commit comments

Comments
 (0)