|
1 | 1 | <h1 align="center">WebGL Tech Particles</h1>
|
2 | 2 |
|
| 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 | + |
3 | 18 | Interactive 3D particle system with technology icons using WebGL and Three.js.
|
4 | 19 |
|
5 | 20 | This project is an interactive 3D visualization of technology icons (e.g., JavaScript, Python, React, Docker, etc.)
|
6 | 21 | implemented with WebGL and Three.js. Particles representing different technologies move dynamically in a 3D space,
|
7 | 22 | connecting with each other based on customizable parameters.
|
8 | 23 |
|
| 24 | +<h2>Install</h2> |
| 25 | + |
| 26 | +Using npm: |
| 27 | + |
| 28 | +```bash |
| 29 | +$ npm i animal-avatar-generator |
| 30 | +``` |
| 31 | + |
9 | 32 | <h2>Usage</h2>
|
10 | 33 |
|
11 | 34 | ```js
|
@@ -45,6 +68,19 @@ Example of `iconList.json`:
|
45 | 68 |
|
46 | 69 | <i>For correct operation, it is better to upload small icons in png and webp formats.</i>
|
47 | 70 |
|
| 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 | + |
48 | 84 | <h2>Settings</h2>
|
49 | 85 |
|
50 | 86 | 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.
|
93 | 129 |
|
94 | 130 | <h2>Credits</h2>
|
95 | 131 | 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> |
0 commit comments