Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tj committed Oct 28, 2012
1 parent cfb779b commit 3cfe4bc
Showing 1 changed file with 29 additions and 1 deletion.
30 changes: 29 additions & 1 deletion Readme.md
Expand Up @@ -9,7 +9,35 @@

## API


### Tween(obj)

Initialize a new `Tween` with `obj`.

### Tween#reset()

Reset the tween.

### Tween#to(obj:Object)

Tween to `obj` and reset internal state.

tween.to({ x: 50, y: 100 })

### Tween#duration(ms:Number)

Set duration to `ms` [500].

### Tween#ease(fn:String|Function)

Set easing function to `fn`.

tween.ease('in-out-sine')

### Tween#update(fn:Function)

Set update function to `fn` or
when no argument is given this performs
a "step".

## License

Expand Down

0 comments on commit 3cfe4bc

Please sign in to comment.