Skip to content

Commit

Permalink
Merge branch 'v1.0.0' of https://github.com/Okazari/Rythm.js into v2.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Okazari committed Mar 4, 2017
2 parents 9151f7e + 235512a commit 94f8072
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ To see each visual effect, you can go to the [Demo](https://okazari.github.io/Ry

Custom dance type
-------
If you want to add you own dance type, you can give a function as the 2nd argument of `addRythm`
If you want to use your own dance type, you can give a function as the 2nd argument of `addRythm`

```js
/* The custom function signature is :
Expand Down Expand Up @@ -211,8 +211,8 @@ Adding new dance type
---------

In v2.0.0 adding a new dance type is pretty easy
1. Create a new file in `src\dances`
2. This file must export your custom dance type function
+ Create a new file in `src\dances`
+ This file must export your custom dance type function

For example, here is the content of `jump.js file`

Expand All @@ -229,7 +229,7 @@ export default (elem, value, options = {}) => {
elem.style.transform = `translateY(${-jump}px)`
}
```
3. Import it and register it into the constructor of `Dancer.js` file
+ Import it and register it into the constructor of `Dancer.js` file
```js
import jump from './dances/jump.js'
class Dancer {
Expand All @@ -239,8 +239,8 @@ class Dancer {
}
```

4. Commit it and create a PR. Then look at everyone enjoying your contribution :) !
+ Commit it and create a PR. Then look at everyone enjoying your contribution :) !

Licence : GNU GPL

Author: [@OkazariBzh](https://twitter.com/OkazariBzh)
Author: [@OkazariBzh](https://twitter.com/OkazariBzh)

0 comments on commit 94f8072

Please sign in to comment.