jparticles/README.md

A succinct, efficient, and lightweight Canvas plugin library for building some cool particle effects.

[![npm version](https://badge.fury.io/js/jparticles.svg)](https://badge.fury.io/js/jparticles) [![dependencies](https://img.shields.io/badge/dependencies-none-brightgreen.svg)](https://www.npmjs.com/package/jparticles) [![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Barrior/JParticles/blob/master/LICENSE)


### Install

```
npm install jparticles --save
```

### Using

```
import JParticles from 'jparticles';
new JParticles.particle('#demo');
```

### On-demand using

```
import JParticles from 'jparticles/production/jparticles';
import 'jparticles/production/particle';
new JParticles.particle('#demo');
```


### Documentation
[See more details from the API documentation.](https://jparticles.js.org/)


### Intro

- JParticles(abbreviation for JavaScript particles) is a lightweight JavaScript library for build user interfaces base on the Canvas. That provide some cool particle effects to bring a surprise for user.

- JParticles effects are mostly shared by others, but it collect them together like a porter and made detail or functional improvements. Here, thanks for the original author's ideas and codes.


### Concept

- API design concept: `"The Write Less, Do More"` and `"Keep It Simple And Stupid"`. I hope the library is very simple and convenient to use, because a tool is to help people achieve their desired functions more quickly, rather than spend too much time to learn. In short, it should be both powerful and easy to extend and simple.

- I hope that codes is succinct and high performance. Thanks for colorful open source projects and something else, because JParticles undoubtedly referenced(standing on the shoulders of giants) your excellent codes or thought.


### 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 failed 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 tell us via [QQ group](http://shang.qq.com/wpa/qunwpa?idkey=f548e3f94e0040a2ac5adfe4fec6915ef67c8c1b6ba5784ff6d5049c6135a759). Thanks.


### License

[MIT](./LICENSE)

Copyright (c) 2016-present, Barrior Wei