deblan/kute.js
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
thednp 2015-11-02 11:58:02 +02:00
parent 6181d45689
commit 976fc30493
1 changed files with 23 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
README.md
View file

@ -8,10 +8,32 @@ Thanks to jsdelivr, we have CDN link <a target="_blank" href="http://www.jsdeliv
# NPM/Bower
You can install this through NPM or bower respectively:
```
$ npm install kute.js
# or
$ bower install kute.js
```
# CommonJS/AMD support
You can use this module through any of the common javascript module systems. For instance:
```javascript
// NodeJS/CommonJS style
var kute = require("kute.js");
// Add Bezier Easing
require("kute.js/kute-bezier");
// Add Physics Easing
require("kute.js/kute-physics");
// AMD
define([
"kute.js",
"kute.js/kute-bezier.js",
"kute.js/kute-physics.js"
], function(KUTE){
// ...
});
```
# Basic Usage
At a glance, you can write one line and you're done.
@ -23,24 +45,6 @@ new KUTE.fromTo('selector', fromValues, toValues, options);
$('selector').KUTE('fromTo', fromValues, toValues, options);
```
# CommonJS/AMD support
You can use this module through any of the common javascript module systems. For instance:
```javascript
// NodeJS/CommonJS style
var kute = require("kute.js");
// Add Bezier/Easing...
require("kute.js/kute-bezier");
// AMD
define([
"kute.js",
"kute.js/kute-bezier.js"
], function(KUTE){
// ...
});
```
# Advanced Usage
Quite easily, you can write 'bit more lines and you're making the earth go round.
```javascript