# JParticles

[![Testing](https://github.com/Barrior/JParticles/actions/workflows/testing.yml/badge.svg?branch=master)](https://github.com/Barrior/JParticles/actions/workflows/testing.yml)
[![Coverage](https://codecov.io/gh/Barrior/JParticles/branch/master/graph/badge.svg?token=JYojJUPPMW)](https://codecov.io/gh/Barrior/JParticles)
[![Gzip Size](https://img.badgesize.io/https://unpkg.com/jparticles@3.4.0/browser/jparticles.base.js?compression=gzip)](https://unpkg.com/jparticles@3.4.0/browser/jparticles.base.js)
[![NPM Version](https://img.shields.io/npm/v/jparticles/latest)](https://www.npmjs.com/package/jparticles)
[![NPM Download](https://img.shields.io/npm/dm/jparticles.svg)](https://www.npmjs.com/package/jparticles)
[![Dependencies](https://img.shields.io/badge/dependencies-none-brightgreen.svg)](https://www.npmjs.com/package/jparticles?activeTab=dependencies)

> English | [中文](./README.md)

[Official Site & API Documentation](https://jparticles.js.org/)


### Animation Effects

- [Particle](https://jparticles.js.org/#/examples/particle)
- [Wave](https://jparticles.js.org/#/examples/wave)
- [WaveLoading](https://jparticles.js.org/#/examples/wave-loading)
- [Snow](https://jparticles.js.org/#/examples/snow)
- [Line](https://jparticles.js.org/#/examples/line)


### Introduction

JParticles(abbreviation for JavaScript particles) is a lightweight JavaScript library for build some cool particle effects in WEB page base on Canvas.


### Concept

The main Concept of API design are: `The Write Less, Do More` and `Keep It Simple And Stupid`. Hope the library is easy-to-use, high performance and easy-to-maintain.


### Compatibility

The library should work fine on the following browsers (because of [this compatibility table](./docs/compatibility_table.md)) :

- IE 9+
- Safari 6+
- Opera 15+
- Firefox 21+
- Chrome 23+

For not support browsers it will fail quietly.


### Communication

If you have any questions or ideas to help JParticles make progress, you are welcome to put forward your views to [issues](https://github.com/Barrior/JParticles/issues) or [discussions](https://github.com/Barrior/JParticles/discussions). Thanks.


### Changelog

Detailed changes for each release are documented in the [release notes](https://github.com/Barrior/JParticles/releases).


### License

[MIT](./LICENSE)

Copyright (c) 2016-present, Barrior