Document the image feature flag, and converting to a base64 png.

README.md

@@ -27,6 +27,7 @@ blurhash = { version = "0.2.3", default-features = false }
 ```
 
 ### Encoding
+
 ```rust
 use blurhash::encode;
 use image::GenericImageView;
@@ -40,15 +41,36 @@ fn main() {
 ```
 
 ### Decoding
+
 ```rust
 use blurhash::decode;
 
 let pixels = decode("LBAdAqof00WCqZj[PDay0.WB}pof", 50, 50, 1.0);
 ```
 
+To decode into an `ImageBuffer`, add the `image` feature flag, then do:
+
+```rust
+use blurhash::decode_image;
+
+let image_buffer = decode_image(blurhash, width, height, 1.0).unwrap();
+```
+
+If you'd like to convert this image to a base64 `png`, you can add the `base64` and `image` crates, then do:
+
+```rust
+use base64::{engine::general_purpose, Engine as _};
+use std::io::Cursor;
+
+let mut bytes: Vec<u8> = Vec::new();
+image_buffer.write_to(&mut Cursor::new(&mut bytes), image::ImageOutputFormat::Png).unwrap();
+
+let b64_png = general_purpose::STANDARD.encode(bytes);
+```
+
 ## Licence
 
 Licensed under either of
 
-* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
-* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
+- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
+- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

src/lib.rs

@@ -20,6 +20,26 @@
 //!
 //! let pixels = decode("LBAdAqof00WCqZj[PDay0.WB}pof", 50, 50, 1.0);
 //! ```
+//!
+//! To decode into an `ImageBuffer`, add the `image` feature flag, then do:
+//!
+//! ```no_run
+//! use blurhash::decode_image;
+//!
+//! let image_buffer = decode_image(blurhash, width, height, 1.0).unwrap();
+//! ```
+//!
+//! If you'd like to convert this image to a base64 `png`, you can add the `base64` and `image` crates, then do:
+//!
+//! ```no_run
+//! use base64::{engine::general_purpose, Engine as _};
+//! use std::io::Cursor;
+//!
+//! let mut bytes: Vec<u8> = Vec::new();
+//! image_buffer.write_to(&mut Cursor::new(&mut bytes), image::ImageOutputFormat::Png).unwrap();
+//!
+//! let b64_png = general_purpose::STANDARD.encode(bytes);
+//! ```
 //! [1]: https://github.com/woltapp/blurhash
 mod ac;
 mod base83;