1 files changed, 36 insertions, 0 deletions
diff --git a/gfx/qcms/README.md b/gfx/qcms/README.md
new file mode 100644
index 0000000000..1997abcabe
--- /dev/null
+++ b/gfx/qcms/README.md
@@ -0,0 +1,36 @@
+# qcms
+[![Crates.io](https://img.shields.io/crates/v/qcms.svg)](https://crates.io/crates/qcms)
+[![Documentation](https://docs.rs/qcms/badge.svg)](https://docs.rs/qcms)
+
+
+Firefox's library for transforming image data between ICC profiles.
+
+## Example
+```rust
+    // Decode the jpeg
+    let mut d = jpeg_decoder::Decoder::new(std::fs::File::open("/Users/jrmuizel/Desktop/DSCF2460.jpg").unwrap());
+    let mut data = d.decode().unwrap();
+    let info = d.info().unwrap();
+
+    // Extract the profile after decode
+    let profile = d.icc_profile().unwrap();
+
+    // Create a new qcms Profile
+    let input = qcms::Profile::new_from_slice(&profile).unwrap();
+    let mut output = qcms::Profile::new_sRGB();
+    output.precache_output_transform();
+
+    // Create a transform between input and output profiles and apply it.
+    let xfm = qcms::Transform::new(&input, &output, qcms::DataType::RGB8, qcms::Intent::default()).unwrap();
+    xfm.apply(&mut data);
+
+    // write the result to a PNG
+    let mut encoder = png::Encoder::new(std::fs::File::create("out.png").unwrap(), info.width as u32, info.height as u32);
+    encoder.set_color(png::ColorType::Rgb);
+    encoder.set_srgb(png::SrgbRenderingIntent::Perceptual);
+    let mut writer = encoder.write_header().unwrap();
+    writer.write_image_data(&data).unwrap(); // Save
+```
+
+This library was originally written in C, was converted to Rust using [c2rust](https://c2rust.com/), and then refactored to be mostly
+safe and more idiomatic Rust.