Skip to content

Commit 91f012c

Browse files
committed
docs: update README.md and package version.
1 parent be62a90 commit 91f012c

File tree

3 files changed

+47
-7
lines changed

3 files changed

+47
-7
lines changed

README.md

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,34 @@
11
<h1 align="center">WebGL Tech Particles</h1>
22

3+
<div align="center">
4+
<a href="https://github.com/a-rudenko/webgl-tech-particles/blob/main/LICENSE" target="_blank" style="text-decoration: none;">
5+
<img src="https://img.shields.io/github/license/a-rudenko/webgl-tech-particles" alt="GitHub license" >
6+
</a>
7+
<a href="https://www.npmjs.com/package/webgl-tech-particles" target="_blank" style="text-decoration: none;">
8+
<img src="https://img.shields.io/npm/v/webgl-tech-particles" alt="Latest version">
9+
</a>
10+
<a href="https://www.npmjs.com/package/webgl-tech-particles" target="_blank" style="text-decoration: none;">
11+
<img src="https://img.shields.io/bundlephobia/min/webgl-tech-particles" alt="Minified size">
12+
</a>
13+
<a href="https://www.npmjs.com/package/webgl-tech-particles" target="_blank" style="text-decoration: none;">
14+
<img src="https://img.shields.io/npm/dw/webgl-tech-particles" alt="npm" >
15+
</a>
16+
</div>
17+
318
Interactive 3D particle system with technology icons using WebGL and Three.js.
419

520
This project is an interactive 3D visualization of technology icons (e.g., JavaScript, Python, React, Docker, etc.)
621
implemented with WebGL and Three.js. Particles representing different technologies move dynamically in a 3D space,
722
connecting with each other based on customizable parameters.
823

24+
<h2>Install</h2>
25+
26+
Using npm:
27+
28+
```bash
29+
$ npm i animal-avatar-generator
30+
```
31+
932
<h2>Usage</h2>
1033

1134
```js
@@ -45,6 +68,19 @@ Example of `iconList.json`:
4568

4669
<i>For correct operation, it is better to upload small icons in png and webp formats.</i>
4770

71+
<h2>CDN Usage</h2>
72+
73+
You can also use this package directly in the browser via CDN without installing it via npm. To do this, include the following script tag in your HTML file:
74+
75+
```html
76+
<script type="module">
77+
import { initWebGLTechParticles } from 'https://cdn.jsdelivr.net/npm/webgl-tech-particles@:vesrion/dist/webgl-tech-particles.js';
78+
initWebGLTechParticles('tech-particles', 'settings.json');
79+
</script>
80+
```
81+
82+
<i>Replace `:vesrion` with the version you need</i>
83+
4884
<h2>Settings</h2>
4985

5086
Example with basic <a href="https://github.com/a-rudenko/webgl-tech-particles/blob/main/settings.json" target="_blank">
@@ -93,4 +129,6 @@ Below is a description of the settings.
93129

94130
<h2>Credits</h2>
95131
It is mainly developed using the JavaScript 3D library <a href="https://github.com/mrdoob/three.js">three.js</a>.
96-
132+
133+
<h2>License</h2>
134+
<a href="https://github.com/a-rudenko/webgl-tech-particles/blob/main/LICENSE">MIT</a>

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "webgl-tech-particles",
3-
"version": "0.0.8",
3+
"version": "1.0.0",
44
"description": "Interactive 3D particle system with technology icons using WebGL",
55
"main": "dist/webgl-tech-particles.js",
66
"module": "dist/webgl-tech-particles.js",
@@ -13,10 +13,12 @@
1313
"prepare": "npm run build"
1414
},
1515
"keywords": [
16-
"WebGL",
17-
"particle",
16+
"webgl",
17+
"particles",
1818
"technology",
19-
"javascript"
19+
"javascript",
20+
"three.js",
21+
"3d"
2022
],
2123
"author": {
2224
"name": "Aleksey Rudenko",

0 commit comments

Comments
 (0)