docs(lib): document blit feature flag

tversteeg · Mar 10, 2024 · 039f9de · 039f9de
1 parent 1b07d65
commit 039f9de
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -1,6 +1,12 @@
 //! Pixel Art rotation algorithms that works with many types of pixel buffers.
 //!
 //! This library allows you to rotate pixel art using the [rotsprite](https://en.wikipedia.org/wiki/Pixel-art_scaling_algorithms#RotSprite) algorithm.
+//!
+//! # Feature Flags
+//!
+//! ## `blit`
+//!
+//! Implement the [`crate::RotSprite`] trait for [`blit::BlitBuffer`], making it easy to get a rotated copy of a blit buffer.
 
 // Make the modules public for benchmarks but don't document it
 #[cfg(feature = "blit")]