docs: update & polish documentation for clarity & consistency (#19)

Author: toddeTV

README.dev.md

@@ -101,8 +101,8 @@ Here's a more detailed explanation of how everything works:
       and `.js` code. For example, in declaration files, the use of `async function` is not allowed.
    2. The `children` partial is recursive and constructs the tree of child indices, using a helper function to
       build the index array.
-   3. The `imports` partial builds a list of imports and takes into account type-only imports. Currently, this is
-      not required and is a remnant of a previous iteration. I decided to keep it in, as it might be useful in the future.
+   3. The `imports` partial builds a list of imports and takes into account type-only imports. Currently, this is not
+      required and is a remnant of a previous iteration. I decided to keep it in, as it might be useful in the future.
    4. The main templates, `declaration` and `runtime`, are now simply wrappers around these partials.
 
 See [PR #16](https://github.com/toddeTV/gltf-type-toolkit/pull/16), which introduces this logic for the first time.

README.md

@@ -18,30 +18,37 @@ With this plugin you get:
 
 - ✅ Type safe glTF file representations with correct inner [three.js](https://github.com/mrdoob/three.js/) types
   like `Object3D`, `Mesh`, etc..
+  - ❗ Currently, we primarily support and generate the [three.js](https://github.com/mrdoob/three.js/) types
+    `Object3D`, `Group`, and `Mesh`. Support for generating types for lights, cameras, materials, and other
+    components is not yet implemented. See and subscribe to
+    [Issue #22](https://github.com/toddeTV/gltf-type-toolkit/issues/22) to stay updated on this development and
+    be notified when these features are added.
 - ✅ Building will fail if a model is missing due to type-safe workflow.
 - ✅ Only the used models are bundled in the final product, not all included in your dev project.
 - ⚠️ Detects and handles [Draco Compression](https://github.com/google/draco) during type generation automatically,
   see [Draco Compression handling](#draco-compression-handling) below for more information.
 - ✅ Works with glTF Seperate (`.gltf` + `.bin` + textures) and glTF Embedded (only `.gltf`) files,
-  see [glTF versions and representations](#gltf-versions-and-representations) below for more information.
+  see [glTF Versions and Representations](#gltf-versions-and-representations) below for more information.
 - ✅ ESM ready.
-- ✅ Bundler agnostic thanks to [Unplugin](https://github.com/unjs/unplugin), so use it with your favorite one, but
-  see chapter [Bundler and Framework Compatibility](#bundler-and-framework-compatibility) below for more details:
-  - [Vite](https://vitejs.dev/)
-  - [Rollup](https://rollupjs.org/)
-  - [Webpack](https://webpack.js.org/)
+- ⚠️ Build tool & bundler agnostic thanks to [Unplugin](https://github.com/unjs/unplugin), so use it with your
+  favorite one, but see chapter
+  [Build Tool, Bundler and Framework Compatibility](#build-tool-bundler-and-framework-compatibility)
+  below for more details like compatibility or known problems:
+  - [Astro](https://astro.build/)
   - [esbuild](https://esbuild.github.io/)
-  - [Rspack](https://www.rspack.dev/)
-  - [Rolldown](https://rolldown.rs/)
   - [Farm](https://www.farmfe.org/)
-  - And every framework build on top of them.
-- ✅ Use with your loved framework like:
-  - [Vue3](https://vuejs.org/)
   - [Nuxt3](https://nuxt.com/)
-  - [Svelte](https://svelte.dev/)
+  - [Rolldown](https://rolldown.rs/)
+  - [Rollup](https://rollupjs.org/)
+  - [Rspack](https://www.rspack.dev/)
+  - [Vite](https://vitejs.dev/)
+  - [Webpack](https://webpack.js.org/)
+  - And every framework build on top of them.
+- ✅ Use it with your favorite framework built on top of the listed build tools above, such as:
   - [React](https://react.dev/)
-  - [Astro](https://astro.build/)
-  - And oll frameworks build on top of the listed bundlers above.
+  - [Svelte](https://svelte.dev/)
+  - [Vue3](https://vuejs.org/)
+  - ...
 
 It will run when your dev server starts and also when you build your project.
 
@@ -75,7 +82,7 @@ For development-related information, including setup instructions for contributo
    *.gltf.d.ts
    *.gltf.js
    ```
-3. Add the plugin to your bundler, for example with [Vite](https://vitejs.dev/):
+3. Add the plugin to your build tool, for example with [Vite](https://vitejs.dev/):
 
    ```ts
    // vite.config.ts
@@ -137,29 +144,35 @@ to different folders, changing paths, or adjusting how the model is handled afte
    innerModel.castShadow = true
    ```
 
-## Bundler and Framework Compatibility
+## Build Tool, Bundler and Framework Compatibility
 
-Thanks to [Unplugin](https://github.com/unjs/unplugin), we support a wide variety of bundlers and frameworks,
+Thanks to [Unplugin](https://github.com/unjs/unplugin), we support a wide variety of build tools and bundlers,
 resulting in the following compatibility in our project:
 
-(Legend: 🟢 Tested & Supported | 🟡 not yet tested | 🔴 Not Supported)
+(Legend: 🟢 Tested & Supported | 🟡 Not Yet Tested | 🔴 Not Supported)
 
-| Bundler  | Status | Note                                                                      |
-| -------- | ------ | ------------------------------------------------------------------------- |
-| vite     | 🟢     |                                                                           |
-| esbuild  | 🟢     |                                                                           |
-| rollup   | 🟢     |                                                                           |
-| webpack  | 🟢     |                                                                           |
-| rspack   | 🟢     |                                                                           |
-| astro    | 🟡     |                                                                           |
-| nuxt     | 🟡     |                                                                           |
-| rolldown | 🟡     | ⚠️ currently experimental in [Unplugin](https://github.com/unjs/unplugin) |
-| farm     | 🔴     | Tested & not working, help is welcome                                     |
+| Build Tool                            | Status | Note                                                                      |
+| ------------------------------------- | ------ | ------------------------------------------------------------------------- |
+| [esbuild](https://esbuild.github.io/) | 🟢     |                                                                           |
+| [Rollup](https://rollupjs.org/)       | 🟢     |                                                                           |
+| [Rspack](https://www.rspack.dev/)     | 🟢     |                                                                           |
+| [Vite](https://vitejs.dev/)           | 🟢     |                                                                           |
+| [Webpack](https://webpack.js.org/)    | 🟢     |                                                                           |
+| [Astro](https://astro.build/)         | 🟡     |                                                                           |
+| [Nuxt3](https://nuxt.com/)            | 🟡     |                                                                           |
+| [Rolldown](https://rolldown.rs/)      | 🟡     | ⚠️ currently experimental in [Unplugin](https://github.com/unjs/unplugin) |
+| [Farm](https://www.farmfe.org/)       | 🔴     | Tested & not working. Contributions welcome! ❤️                           |
 
-## glTF versions and representations
+## glTF Versions and Representations
 
-We only support glTF 2.0, so use glTF Seperate (`.gltf` + `.bin` + textures) or glTF Embedded (only `.gltf`) files.<br>
-We do not support glTF 1 nor glTF Binary (`.glb`) files.
+(Legend: 🟢 Tested & Supported | 🟡 Not Yet Tested | 🔴 Not Supported)
+
+| glTF Version | File Representation                    | Status | Note                                                                                                                                                            |
+| ------------ | -------------------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| glTF 1.0     | Any                                    | 🔴     | glTF 2.0 was introduced in 2017 with major improvements. Avoid using the outdated glTF 1.0 standard in your projects.                                           |
+| glTF 2.0     | Separate (`.gltf` + `.bin` + textures) | 🟢     | Recommended! Offers better performance, version control, caching, transferability, and debugging.                                                               |
+| glTF 2.0     | Embedded (only `.gltf`)                | 🟢     | Assets are embedded directly into the `.gltf` file as base64 encoded `data:` sources within the `uri` fields, making single-file management simpler.            |
+| glTF 2.0     | Binary (`.glb`)                        | 🔴     | Currently not supported because we scan JSON-encoded `.gltf` files for type generation and cannot yet process binary representations. Contributions welcome! ❤️ |
 
 ## Draco Compression handling
 
@@ -211,16 +224,17 @@ scene/ model graph, we store the paths in the graph by caching the child indices
 object. With this, we can O(1) look up what the user requests without the need of traversing - neither depth first
 (default approach from [three.js](https://github.com/mrdoob/three.js/)), nor breath first.
 
-One of the biggest challenges was making the plugin bundler agnostic bc not every bundler handles inner path references
-the same. Therefore, we have to reconstruct the buffers that link the glTF file with the binary and textures by text
-string & replace - kinda hacky, but reliable and the additional runtime is only performed in dev and build, not in the
-production runtime.
+One of the biggest challenges was making the plugin build tool agnostic bc not every build tool handles inner path
+references the same. Therefore, we have to reconstruct the buffers that link the glTF file with the binary and
+textures by text string & replace - kinda hacky, but reliable and the additional runtime is only performed in dev
+and build, not in the production runtime.
 
-## Troubleshooting
+## Troubleshooting with Known Problems and Limitations
 
 If you have problems, maybe one of the following will help:
 
 - Delete your build output folder (maybe some old builds copied model files in there and our plugin is now scanning them).
+- We currently do not provide a watcher. Restart your dev environment when changing model files.
 
 ## Attribution/ Contribution
 
@@ -230,11 +244,16 @@ Project founder & head of project:
 
 Honorable mentions to people that helped this project:
 
-- [Andreas Fehn](https://github.com/fehnomenal) as contributor who helped incredible with the project and the magic behind the core. Thank you <3
+- [Andreas Fehn](https://github.com/fehnomenal) as contributor who helped incredible with the project and the magic
+  behind the core. Thank you <3
 
 Respectable mentions to projects that helped this project:
 
-- \[currently none\]
+- [zlig (zen-landscape-idle-game)](https://github.com/toddeTV/zlig): A Japanese zen-inspired idle browser game that
+  showcases lightweight web technologies like `Vue` and `Three.js` to create fully browser-based games. The idea and
+  initial implementation of this plugin [@todde.tv/gltf-type-toolkit](https://github.com/toddeTV/gltf-type-toolkit)
+  originated during the development of zlig, where we required type-safe glTF representations to enable faster and
+  more reliable development.
 
 Used programs/ softwares, services and dependencies - besides the ones in `./package.json`: