Update docs

Author: beicause

README.md

@@ -64,7 +64,7 @@ The `crates/basisu_sys/` contains a high level wrapper of the basis universal C+
 
 For native platforms, it just builds and statically links the C++ library.
 
-For web, it contains a tool to build basisu vendor using Emscripten and produce js and wasm files. The basisu wrapper is designed so that it does not need to share memory with main Wasm module, instead its memory is copied from/into main Wasm module through javascript. When building this plugin targeting `wasm32-unknown-unknown`, the basisu vendor js and wasm files will be embedded into binary and is called through `wasm-bindgen` and `js-sys`.
+For web, it contains a tool to build basisu vendor using Emscripten and produce js and wasm files. The basisu wrapper is designed so that it does not need to share memory with main Wasm module, instead its memory is copied from/into main Wasm module through javascript. When building this plugin targeting `wasm32-unknown-unknown`, the basisu vendor js and wasm files are embedded into binary and is called through `wasm-bindgen` and `js-sys`.
 
 ## Bevy version compatibility
 

src/lib.rs

@@ -7,11 +7,11 @@ pub use loader::*;
 
 /// Provides a loader for Basis Universal KTX2 textures.
 ///
-/// The file extension must be `.basisu.ktx2` to use this loader. Supports KTX2 UASTC/ETC1S format. Zstd supercompression is supported even if bevy's zstd feature is disabled. No support for `.basis` files.
+/// The file extension must be `.basisu.ktx2` to use this loader. All basis universal compressed formats (ETC1S, UASTC, XUASTC) are supported. Zstd supercompression is always supported. No support for `.basis` files.
 ///
 /// Transcode Target Selection:
 ///
-/// | BasisU format                  | target selection                                                |
+/// | BasisU format                  | target selection                                               |
 /// | ------------------------------ | -------------------------------------------------------------- |
 /// | ETC1S                          | Bc7Rgba/Bc5Rg/Bc4R > Etc2Rgba8/Etc2Rgb8/EacRg11/EacR11 > Rgba8 |
 /// | UASTC_LDR, ASTC_LDR, XUASTC_LDR| Astc > Bc7Rgba > Etc2Rgba8/Etc2Rgb8/EacRg11/EacR11 > Rgba8     |

src/loader.rs

@@ -68,12 +68,12 @@ pub struct BasisuLoaderSettings {
     /// The channel type hint for transcode target selection.
     ///
     /// If [`ChannelType::Auto`], it will be determined by the KTX2 data format descriptor channel type.
-    /// Note: This will be ignored when the transcode target format is not ETC2 or BC4/BC5 and usually has no effect for UASTC textures. See [`BasisuLoaderPlugin`](crate::BasisuLoaderPlugin) for more information about the transcode targets.
+    /// Note: This will be ignored when the transcode target format is not ETC2 or BC4/BC5 so it usually has no effect for UASTC textures. See [`BasisuLoaderPlugin`](crate::BasisuLoaderPlugin) for more information about the transcode targets.
     pub channel_type_hint: ChannelType,
-    /// Forcibly transcode to a specific [`TextureFormat`] if it's not `None`. Otherwise the format will be selected automatically.
+    /// Forcibly transcode to a specific [`TextureFormat`]. If `None` the target format is selected automatically.
     ///
     /// Only set this if you know what you're doing and use this with caution, it will fail if the transcode target is not supported by Basis Universal or the texture format is not supported by the device.
-    /// Srgb-ness is ignored and will be determined by `is_srgb`.
+    /// The srgb-ness of texture format is ignored and will be determined by `is_srgb`.
     pub force_transcode_target: Option<TextureFormat>,
 }