Skip to content

Commit c7ca473

Browse files
Update README.md
1 parent 2425f1c commit c7ca473

File tree

1 file changed

+6
-39
lines changed

1 file changed

+6
-39
lines changed

README.md

Lines changed: 6 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Load particles.js and configure the particles:
2323
particlesJS('particles-js', {
2424
particles: {
2525
color: '#fff',
26-
color_random: false, // true, false or ['#ffaa44', '#ffffaa', '#445500', etc.]
26+
color_random: false,
2727
shape: 'circle', // "circle", "edge" or "triangle"
2828
opacity: {
2929
opacity: 1,
@@ -60,7 +60,7 @@ particlesJS('particles-js', {
6060
distance: 300
6161
},
6262
detect_on: 'canvas', // "canvas" or "window"
63-
mode: 'grab', // "grab" or false
63+
mode: 'grab', // "grab" of false
6464
line_linked: {
6565
opacity: .5
6666
},
@@ -83,47 +83,14 @@ particlesJS('particles-js', {
8383
});
8484
```
8585
-------------------------------
86+
### ***Live Demo***
87+
<a href="http://codepen.io/VincentGarreau/pen/pnlso" target="_blank">CodePen demo</a>
8688

87-
### `Options`
88-
89-
key | option type / notes | example
90-
----|---------|------|------
91-
`particles.number.value` | number | `40`
92-
`particles.number.density.enable` | boolean | `true` / `false`
93-
`particles.number.density.value_area` | number | `800`
94-
`particles.color.value` | HEX (string) <br /> RGB (object) <br /> HSL (object) <br /> array selection (HEX) <br /> random (string) | `"#b61924"` <br /> `{r:182, g:25, b:36}` <br /> `{h:356, s:76, l:41}` <br /> `["#b61924", "#333333", "999999"]` <br /> `"random"`
95-
`particles.number.density.value_area` | number | `800`
96-
`particles.shape.type` | string / array selection | `"circle"` <br /> `"edge"` <br /> `"triangle"` <br /> `"polygon"` <br /> `"star"` <br /> `"image"` <br /> `["circle", "triangle", "image"]`
97-
`particles.shape.stroke.width` | number | `2`
98-
`particles.shape.stroke.color` | HEX (string) | `"#222222"`
99-
`particles.shape.polygon.nb_slides` | number | `5`
100-
`particles.shape.image.src` | path link <br /> svg / png / gif / jpg | `"assets/img/yop.svg"` <br /> `"http://mywebsite.com/assets/img/yop.png"`
101-
`particles.shape.image.width` | number <br />(for aspect ratio) | `100`
102-
`particles.shape.image.height` | number <br />(for aspect ratio) | `100`
103-
`particles.opacity.value` | number (0 to 1) | `0.75`
104-
`particles.opacity.random` | boolean | `true` / `false`
105-
`particles.opacity.anim.enable` | boolean | `true` / `false`
106-
`particles.opacity.anim.speed` | number | `3`
107-
`particles.opacity.anim.opacity_min` | number (0 to 1) | `0.25`
108-
`particles.opacity.anim.sync` | boolean | `true` / `false`
109-
`particles.size.value` | number | `20`
110-
`particles.size.random` | boolean | `true` / `false`
111-
`particles.size.anim.enable` | boolean | `true` / `false`
112-
`particles.size.anim.speed` | number | `3`
113-
`particles.size.anim.size_min` | number | `0.25`
114-
`particles.size.anim.sync` | boolean | `true` / `false`
115-
`particles.line_linked.enable` | boolean | `true` / `false`
89+
<a href="http://htmlpreview.github.io/?https://github.com/VincentGarreau/particles.js/blob/master/demo/index.html" target="_blank">GitHub demo</a>
11690

11791
-------------------------------
11892

119-
### `Packages install`
120-
121-
##### ***Bower***
93+
##### ***Install with Bower***
12294
```
12395
bower install particles.js --save
12496
```
125-
126-
##### ***Rails Assets***
127-
```
128-
gem 'rails-assets-particles.js'
129-
```

0 commit comments

Comments
 (0)