Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
lindelof authored Dec 22, 2019
1 parent 0535863 commit 05ebea9
Showing 1 changed file with 14 additions and 27 deletions.
41 changes: 14 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,34 +46,21 @@ class Example extends Component {
```jsx
<MouseParticles g={1} num={6} color="random" cull="stats,image-wrapper" level={6} />
```
#### * `g` - Whether to add gravity: Number

#### * `num` - The number of particles emitted each time: Number

#### * `radius` - The radius of every particle: Number

#### * `alpha` - The alpha of every particle: Number

#### * `tha` - The Particle emitter angle

#### * `v` - The Particle emitter Particle velocity

#### * `life` - The life of every particle: Number

#### * `color` - Particle color, array or string
```javascript
<MouseParticles g={1} color="random" />
// or

<MouseParticles g={1} color={["#ff0000", "#ccdfs2"]} />
```

#### * `cull` - Eliminate dom's className without triggering animation
```javascript
<MouseParticles cull="container,image-wrapper" />
```

#### * `level` - Detect levels of culling animation
key | describe |type | example
----|-----|-----|------
`g` | Whether to add gravity | number | `1`
`num` | The number of particles emitted each time | number | `3`
`radius` | The radius of every particle | number | `10`
`alpha` | The alpha of every particle | number | `.1`
`tha` | The Particle emitter angle | number | `20`
`v` | The Particle emitter Particle velocity | number | `0.5`
`life` | The life of every particle | number | `1.2`
`color` | Particle color | array or string | `<MouseParticles g={1} color="random" /> // or <MouseParticles g={1} color={["#ff0000", "#ccdfs2"]} />`
`cull` | Eliminate dom's className without triggering animation | string | `<MouseParticles cull="container,image-wrapper" />`
`level` | Detect levels of culling animation | number | `6`

---

## Contribution
I very much hope that you can work with me to modify the code. I also have a lot of fun ideas. Maybe you can join me to implement it.
Expand Down

0 comments on commit 05ebea9

Please sign in to comment.