Apply changesets and update CHANGELOG

Author: mayank1513

lib/README.md

@@ -1,20 +1,8 @@
 # Esbuild Plugin Webgl <img src="https://github.com/react18-tools/esbuild-plugin-webgl/blob/main/popper.png?raw=true" style="height: 40px"/>
 
-[![test](https://github.com/react18-tools/esbuild-plugin-webgl/actions/workflows/test.yml/badge.svg)](https://github.com/react18-tools/esbuild-plugin-webgl/actions/workflows/test.yml) [![Maintainability](https://api.codeclimate.com/v1/badges/aa896ec14c570f3bb274/maintainability)](https://codeclimate.com/github/react18-tools/esbuild-plugin-webgl/maintainability) [![codecov](https://codecov.io/gh/react18-tools/esbuild-plugin-webgl/graph/badge.svg)](https://codecov.io/gh/react18-tools/esbuild-plugin-webgl) [![Version](https://img.shields.io/npm/v/esbuild-plugin-webgl.svg?colorB=green)](https://www.npmjs.com/package/esbuild-plugin-webgl) [![Downloads](https://img.jsdelivr.com/img.shields.io/npm/d18m/esbuild-plugin-webgl.svg)](https://www.npmjs.com/package/esbuild-plugin-webgl) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/esbuild-plugin-webgl) [![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/from-referrer/)
+[![test](https://github.com/react18-tools/esbuild-plugin-webgl/actions/workflows/test.yml/badge.svg)](https://github.com/react18-tools/esbuild-plugin-webgl/actions/workflows/test.yml) [![Maintainability](https://api.codeclimate.com/v1/badges/c2532ae011e53b1bf011/maintainability)](https://codeclimate.com/github/react18-tools/esbuild-plugin-webgl/maintainability) [![codecov](https://codecov.io/gh/react18-tools/esbuild-plugin-webgl/graph/badge.svg)](https://codecov.io/gh/react18-tools/esbuild-plugin-webgl) [![Version](https://img.shields.io/npm/v/esbuild-plugin-webgl.svg?colorB=green)](https://www.npmjs.com/package/esbuild-plugin-webgl) [![Downloads](https://img.jsdelivr.com/img.shields.io/npm/d18m/esbuild-plugin-webgl.svg)](https://www.npmjs.com/package/esbuild-plugin-webgl) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/esbuild-plugin-webgl) [![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/from-referrer/)
 
-Esbuild Plugin Webgl is a comprehensive library designed to unlock the full potential of React 18 server components. It provides customizable loading animation components and a fullscreen loader container, seamlessly integrating with React and Next.js.
-
-✅ Fully Treeshakable (import from `esbuild-plugin-webgl/client/loader-container`)
-
-✅ Fully TypeScript Supported
-
-✅ Leverages the power of React 18 Server components
-
-✅ Compatible with all React 18 build systems/tools/frameworks
-
-✅ Documented with [Typedoc](https://react18-tools.github.io/esbuild-plugin-webgl) ([Docs](https://react18-tools.github.io/esbuild-plugin-webgl))
-
-✅ Examples for Next.js, Vite, and Remix
+ESBuild plugin to load webGL shaders from `.glsl` files.
 
 > <img src="https://github.com/react18-tools/esbuild-plugin-webgl/blob/main/popper.png?raw=true" style="height: 20px"/> Please consider starring [this repository](https://github.com/react18-tools/esbuild-plugin-webgl) and sharing it with your friends.
 
@@ -38,87 +26,34 @@ $ npm install esbuild-plugin-webgl
 $ yarn add esbuild-plugin-webgl
 ```
 
-## Want Lite Version? [![npm bundle size](https://img.shields.io/bundlephobia/minzip/esbuild-plugin-webgl-lite)](https://www.npmjs.com/package/esbuild-plugin-webgl-lite) [![Version](https://img.shields.io/npm/v/esbuild-plugin-webgl-lite.svg?colorB=green)](https://www.npmjs.com/package/esbuild-plugin-webgl-lite) [![Downloads](https://img.jsdelivr.com/img.shields.io/npm/d18m/esbuild-plugin-webgl-lite.svg)](https://www.npmjs.com/package/esbuild-plugin-webgl-lite)
-
-```bash
-$ pnpm add esbuild-plugin-webgl-lite
-```
-
-**or**
-
-```bash
-$ npm install esbuild-plugin-webgl-lite
-```
-
-**or**
-
-```bash
-$ yarn add esbuild-plugin-webgl-lite
-```
-
-> You need `r18gs` as a peer-dependency
-
-### Import Styles
-
-You can import styles globally or within specific components.
-
-```css
-/* globals.css */
-@import "esbuild-plugin-webgl/dist";
-```
-
-```tsx
-// layout.tsx
-import "esbuild-plugin-webgl/dist/index.css";
-```
-
-For selective imports:
-
-```css
-/* globals.css */
-@import "esbuild-plugin-webgl/dist/client"; /** required if you are using LoaderContainer */
-@import "esbuild-plugin-webgl/dist/server/bars/bars1";
-```
-
-### Usage
+> If you are using `monorepo` or `workspaces`, you can install this plugin to the root using `-w` or to a specific workspace using `--filter your-package` or `--scope your-package` for `pnpm` or `yarn` workspaces, respectively.
 
-Using loaders is straightforward.
+## Use with `tsup`
 
-```tsx
-import { Bars1 } from "esbuild-plugin-webgl/dist/server/bars/bars1";
+```ts
+// tsup.config.ts or tsup.config.js
+import { defineConfig } from "tsup";
+import { webglPlugin } from "esbuild-plugin-webgl";
 
-export default function MyComponent() {
-  return someCondition ? <Bars1 /> : <>Something else...</>;
-}
+export default defineConfig(options => ({
+    ...
+    esbuildPlugins:[webglPlugin()]
+}));
 ```
 
-For detailed API and options, refer to [the API documentation](https://react18-tools.github.io/esbuild-plugin-webgl).
+## Use with `esbuild`
 
-**Using LoaderContainer**
+```ts
+import { webglPlugin } from "esbuild-plugin-webgl";
 
-`LoaderContainer` is a fullscreen component. You can add this component directly in your layout and then use `useLoader` hook to toggle its visibility.
-
-```tsx
-// layout.tsx
-<LoaderContainer />
-	 ...
-```
-
-```tsx
-// some other page or component
-import { useLoader } from "esbuild-plugin-webgl/dist/hooks";
-
-export default MyComponent() {
-	const { setLoading } = useLoader();
-	useCallback(()=>{
-		setLoading(true);
-		...do some work
-		setLoading(false);
-	}, [])
+esbuild.build({
 	...
-}
+	plugins: [webglPlugin()],
+});
 ```
 
+![Alt](https://repobeats.axiom.co/api/embed/a1fadcf8aa3054acff5d430c970af9e61254da5c.svg "Repobeats analytics image")
+
 ## License
 
 This library is licensed under the MPL-2.0 open-source license.