mz-particles/src/docs/data/pages/10-main/1-basic-usage.md

TypeScript library for creating particle effects on canvas.

## Basic Usage

To use the library, you need to install the module using npm:

```cmd
npm install mz-particles
```

Or using Yarn:

```cmd
yarn add mz-particles
```

Then you can import any function as follows:

```js
import { particles } from 'mz-particles';

particles({
    $placeholder: document.getElementById('placeholder'),
    canvasColor: 'rgb(17, 24, 39)',
    particlesNumber: 100,
});
```

You can also use it without bundlers. Download the latest [mz-particles.min.js](https://github.com/mzusin/mz-particles/blob/main/dist/mz-particles.min.js) script from GitHub and add it to the page as follows:

```html
<script src="mz-particles.min.js"></script>
<script>
    window.particles({
        $placeholder: document.getElementById('placeholder'),
        canvasColor: 'rgb(17, 24, 39)',
        particlesNumber: 100,
    });
</script>
```