Skip to content

Commit 6b1ef20

Browse files
committed
Apply changesets and update CHANGELOG
1 parent 89acf92 commit 6b1ef20

File tree

1 file changed

+22
-20
lines changed

1 file changed

+22
-20
lines changed

lib/README.md

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
1-
# Webgl Generative Particles <img src="https://github.com/react18-tools/webgl-generative-particles/blob/main/popper.png?raw=true" style="height: 40px"/>
1+
# WebGL Generative Particles <img src="https://github.com/react18-tools/webgl-generative-particles/blob/main/popper.png?raw=true" style="height: 40px"/>
22

3-
> This library is a Work In Progress... Feel free to request features, report bugs or contribute.
4-
> We will try to keep the APIs stable, however, some APIs might change.
3+
> This library is a Work In Progress. Feel free to request features, report bugs, or contribute. We aim to keep the APIs stable, though some changes may occur.
54
65
[![test](https://github.com/react18-tools/webgl-generative-particles/actions/workflows/test.yml/badge.svg)](https://github.com/react18-tools/webgl-generative-particles/actions/workflows/test.yml) [![Maintainability](https://api.codeclimate.com/v1/badges/17e43ef7ca4593a18757/maintainability)](https://codeclimate.com/github/react18-tools/webgl-generative-particles/maintainability) [![codecov](https://codecov.io/gh/react18-tools/webgl-generative-particles/graph/badge.svg)](https://codecov.io/gh/react18-tools/webgl-generative-particles) [![Version](https://img.shields.io/npm/v/webgl-generative-particles.svg?colorB=green)](https://www.npmjs.com/package/webgl-generative-particles) [![Downloads](https://img.jsdelivr.com/img.shields.io/npm/d18m/webgl-generative-particles.svg)](https://www.npmjs.com/package/webgl-generative-particles) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/webgl-generative-particles) [![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/from-referrer/)
76

87
"webgl-generative-particles" is an efficient WebGL-based generative particle system simulator designed for both React and vanilla JS applications. This system follows the mouse pointer, providing interactive and dynamic visual effects. It offers seamless integration with React (including React 18 and beyond) and Next.js, making it an ideal choice for modern frontend development. The simulator is customizable, compatible with various frameworks, and delivers high performance and real-time rendering for progressive web development.
98

9+
> Check out the live demo at - https://webgl-generative-particles.vercel.app/
10+
11+
## Features
12+
1013
✅ Fully Treeshakable (import from `webgl-generative-particles/react`)
1114

1215
✅ Fully TypeScript Supported
@@ -25,17 +28,19 @@
2528

2629
### Installation
2730

31+
Using pnpm:
32+
2833
```bash
2934
$ pnpm add webgl-generative-particles
3035
```
3136

32-
**_or_**
37+
Using npm:
3338

3439
```bash
3540
$ npm install webgl-generative-particles
3641
```
3742

38-
**_or_**
43+
Using yarn:
3944

4045
```bash
4146
$ yarn add webgl-generative-particles
@@ -58,35 +63,32 @@ import { Particles } from "webgl-generative-particles/react";
5863

5964
```ts
6065
export interface ParticlesOptions {
61-
/** particle Color @defaultValue [1, 0, 0, 1] -> red */
66+
/** Particle Color @defaultValue [1, 0, 0, 1] -> red */
6267
rgba?: [number, number, number, number];
63-
/** @defaultValue 100_000 */
68+
/** Maximum number of particles @defaultValue 100_000 */
6469
maxParticles?: number;
65-
/** @defaultValue 0.5 */
70+
/** Particle generation rate @defaultValue 0.5 */
6671
generationRate?: number;
67-
/** @defaultValue false */
72+
/** Overlay mode @defaultValue false */
6873
overlay?: boolean;
69-
/** @defaultValue false */
74+
/** Disable mouse interaction @defaultValue false */
7075
mouseOff?: boolean;
71-
/** min and max Angles in radians: @defaultValue [-Math.PI, Math.PI] */
76+
/** Min and max angles in radians @defaultValue [-Math.PI, Math.PI] */
7277
angleRange?: [number, number];
73-
/** min and max age of particles in seconds */
78+
/** Min and max age of particles in seconds */
7479
ageRange?: [number, number];
75-
/** [minSpeed, maxSpeed] */
80+
/** Speed range [minSpeed, maxSpeed] */
7681
speedRange?: [number, number];
77-
/** Initial origin -> Will update as per mouse position when mouse moved if mouseOff is not set.
78-
* @defaultValue [0, 0]
79-
*/
82+
/** Initial origin, will update as per mouse position if mouseOff is not set @defaultValue [0, 0] */
8083
origin?: [number, number];
81-
/** todo */
82-
/** todo: WIP constant force [fx, fy] or a force field texture */
84+
/** Constant force [fx, fy] or a force field texture (Work In Progress) */
8385
forceField?: Vector2D; //| Vector[][] | string;
8486
}
8587
```
8688

87-
## Creadits
89+
## Credits
8890

89-
I have learnt the concepts from the following blogs and tutorials.
91+
The concepts in this library were learned from the following blogs and tutorials:
9092

9193
- https://experiments.withgoogle.com/search?q=particles
9294
- https://nullprogram.com/blog/2014/06/29/

0 commit comments

Comments
 (0)