docs(h265): root docs

Author: lennartkloock

crates/h265/src/lib.rs

@@ -1,22 +1,28 @@
-//! A pure Rust implementation of the H.265 encoder and decoder.
+//! A pure Rust implementation of the HEVC/H.265 decoder.
 //!
-//! This crate is designed to provide a simple and safe interface to encode and decode H.265 headers.
-//!
-//! ## Why do we need this?
-//!
-//! This crate aims to provide a simple and safe interface for h265.
+//! This crate is designed to provide a simple and safe interface to decode HEVC/H.265 SPS NALUs.
 //!
 //! ## How is this different from other h265 crates?
 //!
-//! The other main h265 crate is TODO.
+//! TODO
 //!
 //! ## Notable features
 //!
-//! This crate is a completely safe implementation of H265 encoding and decoding, which means there is no unsafe code!
+//! This crate is a completely safe implementation of HEVC/H.265 SPS NALU decoding.
 //!
 //! ## Examples
 //!
-//! TODO
+//! ```
+//! use scuffle_h265::SpsNALUnit;
+//!
+//! # fn test() -> std::io::Result<()> {
+//! # let data = b"\x42\x01\x01\x01\x40\x00\x00\x03\x00\x90\x00\x00\x03\x00\x00\x03\x00\x78\xa0\x03\xc0\x80\x11\x07\xcb\x96\xb4\xa4\x25\x92\xe3\x01\x6a\x02\x02\x02\x08\x00\x00\x03\x00\x08\x00\x00\x03\x00\xf3\x00\x2e\xf2\x88\x00\x02\x62\x5a\x00\x00\x13\x12\xd0\x20";
+//! # let reader = std::io::Cursor::new(data);
+//! let nalu = SpsNALUnit::parse(reader)?;
+//! println!("Parsed SPS NALU: {:?}", nalu);
+//! # Ok(())
+//! # }
+//! ```
 //!
 //! ## Status
 //!