Skip to content
This repository has been archived by the owner on May 26, 2020. It is now read-only.

Commit

Permalink
Merge branch 'release-2.1.0'
Browse files Browse the repository at this point in the history
  • Loading branch information
Marc Brüderlin committed Oct 30, 2017
2 parents dd1df1e + 685f277 commit af80ee9
Show file tree
Hide file tree
Showing 8 changed files with 451 additions and 226 deletions.
2 changes: 1 addition & 1 deletion .jshintrc
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@
"strict": true,
"maxparams": 5,
"maxdepth": 5,
"maxstatements": 20,
"maxstatements": 30,
"maxcomplexity": 10
}
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright © 2017 Marc Brüderlin
Copyright © 2017 Marc Bruederlin

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the “Software”), to deal
Expand Down
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ particles.js is a lightweight, dependency-free and responsive javascript plugin
There are several ways to install particles.js:
- [Download the latest version](https://github.com/marcbruederlin/particles.js/archive/master.zip)
- Install with npm: `npm install particlesjs --save`
- Use the CDN: `https://npmcdn.com/particlesjs@2.0.2/dist/particles.min.js`
- Use the CDN: `https://npmcdn.com/particlesjs@2.1.0/dist/particles.min.js`

## Usage
Include the minified JS in your HTML (right before the closing body tag).
Expand Down Expand Up @@ -66,10 +66,17 @@ Option | Type | Default | Description
`color` | string | `#000000` | *Optional:* Color of particles and connecting lines
`minDistance` | integer | `120` | *Optional:* Distance in `px` for connecting lines
`connectParticles` | boolean | `false` | *Optional:* `true`/`false` if connecting lines should be drawn
`showParticles` | boolean | `true` | *Optional:* `true`/`false` if particles should be drawn
`responsive` | array | `null` | *Optional:* Array of objects containing breakpoints and options

Example how to use the [responsive option](https://marcbruederlin.github.io/particles.js/#responsive-option).

## Methods
Method | Description
------ | -----------
`pauseAnimation` | Pauses/stops the particle animation
`resumeAnimation` | Continues the particle animation

## Browser Support
IE9+ and all modern browsers.

Expand All @@ -85,7 +92,7 @@ If you’re using particles.js in some interesting way or on a cool site, I’d
For any problems or questions don't hesitate to open an issue.<br />

## License
particles.js is created by [Marc Brüderlin](https://marcbruederlin.com) and released
particles.js is created by [Marc Brüderlin](https://marcbruederlin.com) and released
under the [MIT license](https://github.com/marcbruederlin/particles.js/blob/master/LICENSE).

## Version 1.x
Expand Down
Loading

0 comments on commit af80ee9

Please sign in to comment.