docs: add content, refactor content & rename dev README (#43)

Author: toddeTV

.npmignore

@@ -30,27 +30,6 @@ Development VM ID from Thorsten for this project: `014`<br>
 6. Install dependencies: `pnpm i`
 7. Happy coding <3
 
-## lint and prettier
-
-This project uses [antfu/eslint-config](https://github.com/antfu/eslint-config) for eslint most of the files.
-The following extend it:
-
-- [antfu/eslint-plugin-format](https://github.com/antfu/eslint-plugin-format) for using external formatters like
-  e.g. `prettier` for the file types that eslint cannot handle.
-- [azat-io/eslint-plugin-perfectionist](https://github.com/azat-io/eslint-plugin-perfectionist) for
-  sorting object keys, imports, etc. - with auto-fix.
-
-Keep in mind that the plugin names are renamed, see
-[Plugins Rename](https://github.com/antfu/eslint-config?tab=readme-ov-file#plugins-renaming), e.g.:
-
-```diff
--// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
-+// eslint-disable-next-line ts/consistent-type-definitions
-type foo = { bar: 2 }
-```
-
-[Why I don't use Prettier for every file type](https://antfu.me/posts/why-not-prettier)
-
 ## GitHub workflow commands inside commit messages
 
 The commit message trigger must be present in the main commit message, so to say the first line, not the description.
@@ -128,6 +107,27 @@ Here's a more detailed explanation of how everything works:
 
 See [PR #16](https://github.com/toddeTV/gltf-type-toolkit/pull/16), which introduces this logic for the first time.
 
+## lint and prettier
+
+This project uses [antfu/eslint-config](https://github.com/antfu/eslint-config) for eslint most of the files.
+The following extend it:
+
+- [antfu/eslint-plugin-format](https://github.com/antfu/eslint-plugin-format) for using external formatters like
+  e.g. `prettier` for the file types that eslint cannot handle.
+- [azat-io/eslint-plugin-perfectionist](https://github.com/azat-io/eslint-plugin-perfectionist) for
+  sorting object keys, imports, etc. - with auto-fix.
+
+Keep in mind that the plugin names are renamed, see
+[Plugins Rename](https://github.com/antfu/eslint-config?tab=readme-ov-file#plugins-renaming), e.g.:
+
+```diff
+-// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
++// eslint-disable-next-line ts/consistent-type-definitions
+type foo = { bar: 2 }
+```
+
+[Why I don't use Prettier for every file type](https://antfu.me/posts/why-not-prettier)
+
 ## Docs and helper websites
 
 \[currently none\]

README.dev.md README-dev.mdREADME.dev.md renamed to README-dev.md

@@ -10,8 +10,8 @@ models in web projects, while being bundler-agnostic (Vite, Rollup, Webpack, esb
 ## project overview
 
 This plugin scans all model files in the project source, deconstructs the glTF JSON representation, and places
-generated type files next to them. It uses [three.js](https://github.com/mrdoob/three.js/) to parse the glTF files,
-including modifications like path resolutions etc.
+generated type files next to them. It creates [three.js](https://github.com/mrdoob/three.js/) types and uses
+it internally to parse the glTF files, including modifications like path resolutions etc.
 
 With this plugin you get:
 
@@ -47,10 +47,9 @@ With this plugin you get:
   - [React](https://react.dev/)
   - [Svelte](https://svelte.dev/)
   - [Vue3](https://vuejs.org/)
+  - [Angular](https://angular.dev/)
   - ...
 
-It will run when your dev server starts and also when you build your project.
-
 ## Sponsoring
 
 If you like this plugin and want to support us, we would be very happy to see you as a sponsor on GitHub ❤️<br>
@@ -61,26 +60,30 @@ Thanks a lot for the support <3
 ## Developer Documentation
 
 For development-related information, including setup instructions for contributors, please refer to the
-[Developer README](./README.dev.md).
+Developer README [`README-dev.md`](./README-dev.md).
 
 ## Getting Started
 
 ### Installation
 
-1. Install with your package manager (we use pnpm and recommend it):<br>
+1. Install with your package manager (we use pnpm and recommend it):
+
    ```bash
-   # choose only one
+   # choose your package manager
    pnpm add -D @todde.tv/gltf-type-toolkit
    npm install --save-dev @todde.tv/gltf-type-toolkit
    yarn add --dev @todde.tv/gltf-type-toolkit
    bun add --dev @todde.tv/gltf-type-toolkit
    ```
+
 2. Extend your `.gitignore` file to exclude generated files:
+
    ```sh
    # Generated glTF model files
    *.gltf.d.ts
    *.gltf.js
    ```
+
 3. Add the plugin to your build tool, for example with [Vite](https://vitejs.dev/):
 
    ```ts
@@ -106,15 +109,24 @@ For development-related information, including setup instructions for contributo
 
 ### usage example with explanations
 
+The plugin will run on:
+
+- on dependency installation
+- on dev server start
+- on project build
+
 Here's an example of how to use the plugin. You can customize this example to suit your needs, such as saving models
 to different folders, changing paths, or adjusting how the model is handled after import.
 
 1. Install the plugin (See [Installation](#installation) above).
+
 2. Add a model to your project, here in the project source under `@/assets/models`. We copy the following in it:
+
    1. `MyModel.gltf` The glTF JSON representation that describes the model.
    2. `MyModel.bin` The binary file of the model, compressed with the [Draco Compression](https://github.com/google/draco).
    3. `MyModel-texture1.png` A texture that the model uses.
    4. `MyModel-texture2.png` A second texture that the model uses.
+
 3. Start your dev to generate all files. With our example model we get:
 
    ```diff
@@ -260,8 +272,8 @@ 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. Thank you mate,
+  you rock <3
 
 Respectable mentions to projects that helped this project: