From 5560d5d092a4849cfe1ce63d85cef57c07ce8d8b Mon Sep 17 00:00:00 2001 From: Silas Bartha Date: Mon, 3 Jun 2024 22:00:19 -0400 Subject: Added docs + renamed --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 4f0bf79..84a918a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# grex_framebuffer_extract +# bevy_framebuffer_extract A plugin for the [Bevy](https://bevyengine.org) engine which allows for exporting framebuffer data from a camera. @@ -15,8 +15,8 @@ Currently it only supports cameras which render to a render texture. ### Using git URL in Cargo.toml ```toml -[dependencies.grex_framebuffer_extract] -git = "https://github.com/exvacuum/grex_framebuffer_extract.git" +[dependencies.bevy_framebuffer_extract] +git = "https://github.com/exvacuum/bevy_framebuffer_extract.git" ``` ## Usage @@ -24,13 +24,13 @@ git = "https://github.com/exvacuum/grex_framebuffer_extract.git" In `main.rs`: ```rs use bevy::prelude::*; -use grex_framebuffer_extract; +use bevy_framebuffer_extract; fn main() { App::new() .add_plugins(( DefaultPlugins, - grex_framebuffer_extract::FramebufferExtractPlugin, + bevy_framebuffer_extract::FramebufferExtractPlugin, )) .run(); } @@ -72,7 +72,7 @@ commands.spawn(( }, ..Default::default() }, - grex_framebuffer_extract::ExtractFramebufferBundle { + bevy_framebuffer_extract::ExtractFramebufferBundle { source: framebuffer_extract_sources.add(FramebufferExtractSource(image_handle.clone())), // ResMut> destination: FramebufferExtractDestination::default(), }, -- cgit v1.2.3