From 5560d5d092a4849cfe1ce63d85cef57c07ce8d8b Mon Sep 17 00:00:00 2001
From: Silas Bartha <silas@exvacuum.dev>
Date: Mon, 3 Jun 2024 22:00:19 -0400
Subject: Added docs + renamed

---
 src/lib.rs | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

(limited to 'src/lib.rs')

diff --git a/src/lib.rs b/src/lib.rs
index 05f387d..29a5896 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,3 +1,8 @@
+#![warn(missing_docs)]
+
+//! Plugin for the Bevy game engine which provides the ability to extract the frambuffer image after rendering
+//! to use for whatever you want.
+
 use bevy::{
     prelude::*,
     render::{
@@ -9,11 +14,15 @@ use components::FramebufferExtractDestination;
 use nodes::{FramebufferExtractLabel, FramebufferExtractNode};
 use render_assets::FramebufferExtractSource;
 
+/// Components used by this plugin.
 pub mod components;
-mod nodes;
+/// Render assets used by this plugin.
 pub mod render_assets;
+
+mod nodes;
 mod systems;
 
+/// Plugin which handles framebuffer extraction.
 pub struct FramebufferExtractPlugin;
 
 impl Plugin for FramebufferExtractPlugin {
-- 
cgit v1.2.3