diff options
Diffstat (limited to 'vendor/jpeg-decoder/README.md')
-rw-r--r-- | vendor/jpeg-decoder/README.md | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/vendor/jpeg-decoder/README.md b/vendor/jpeg-decoder/README.md new file mode 100644 index 0000000..8275725 --- /dev/null +++ b/vendor/jpeg-decoder/README.md @@ -0,0 +1,38 @@ +# jpeg-decoder + +[![Rust CI](https://github.com/image-rs/jpeg-decoder/workflows/Rust%20CI/badge.svg)](https://github.com/image-rs/jpeg-decoder/actions) +[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/k65rrkd0f8yb4o9w/branch/master?svg=true)](https://ci.appveyor.com/project/kaksmet/jpeg-decoder/branch/master) +[![Crates.io](https://img.shields.io/crates/v/jpeg-decoder.svg)](https://crates.io/crates/jpeg-decoder) + +A Rust library for decoding JPEGs. + +[Documentation](https://docs.rs/jpeg-decoder) + +## Example + +Cargo.toml: +```toml +[dependencies] +jpeg-decoder = "0.2" +``` + +main.rs: +```rust +extern crate jpeg_decoder as jpeg; + +use std::fs::File; +use std::io::BufReader; + +fn main() { + let file = File::open("hello_world.jpg").expect("failed to open file"); + let mut decoder = jpeg::Decoder::new(BufReader::new(file)); + let pixels = decoder.decode().expect("failed to decode image"); + let metadata = decoder.info().unwrap(); +} +``` + +## Requirements + +This crate compiles with rust >= 1.48. Minimum Supported Rust Version: +- All releases `0.1.*` compile with rust >= 1.36. +- The releases `0.2.*` may bump Rust Version requirements (TBD). |