Comparing version 1.0.0 to 1.0.1
@@ -0,0 +0,0 @@ 'use strict'; |
{ | ||
"name": "anymation", | ||
"version": "1.0.0", | ||
"version": "1.0.1", | ||
"description": "Simple & easy animation/tweener", | ||
@@ -5,0 +5,0 @@ "main": "index.js", |
# anymation | ||
> Simple stand-alone animation / tweening library. Currently works in node or in browsers w/ [browserify](http://browserify.org/). | ||
Simple stand-alone animation / tweening library for node or browsers. | ||
## Installation | ||
### Installation | ||
For node or browserify, | ||
For node or [browserify](http://browserify.org/), | ||
@@ -13,3 +13,3 @@ > npm install browserify | ||
## Basic use | ||
### Basic use | ||
@@ -41,3 +41,3 @@ ```javascript | ||
## Easing functions | ||
### Easing functions | ||
@@ -56,5 +56,5 @@ Anymation doesn't provide any built-in easing functions except for the trivial linear default. Specifying an easing function from a library like [eases](https://www.npmjs.com/package/eases) is super-easy though. | ||
## API | ||
### API | ||
### Animation(options) | ||
#### Animation(options) | ||
@@ -71,3 +71,3 @@ Constructor for an Animation. Calling it with the new operator is optional. The animation starts immediately. | ||
## Animation.tween(propertyName, from, to) returns this Animation | ||
#### Animation.tween(propertyName, from, to) returns this Animation | ||
@@ -80,3 +80,3 @@ Smoothly change a numeric property between the start and end values. Shortcut for Animation.addProp(propertyName, { tween: [from, to] }). | ||
## Animation.discrete(propertyName, array) returns this Animation | ||
#### Animation.discrete(propertyName, array) returns this Animation | ||
@@ -88,3 +88,3 @@ Cycle a property through a specified list of values (of any type) over the course of the animation. Shortcut for Animation.addProp(propertyName, { discreteValues: array }). | ||
## Animation.fn(propertyName, fn) returns this Animation | ||
#### Animation.fn(propertyName, fn) returns this Animation | ||
@@ -96,3 +96,3 @@ Animate a property using a callback function returning a value of any type. Shortcut for Animation.addProp(propertyName, { valueFn: fn}); | ||
## Animation.addProp(propertyName, options) returns this Animation | ||
#### Animation.addProp(propertyName, options) returns this Animation | ||
@@ -110,3 +110,3 @@ Animates a property during the course of the animation, specifying all options, many of which can override the animation's default options. | ||
## Animation.update(timeNow) returns boolean | ||
#### Animation.update(timeNow) returns boolean | ||
@@ -117,2 +117,6 @@ Updates all animated properties. Generally no need to pass the timeNow parameter. | ||
Returns false if the animation is done (if timeNow >= the animation start time + the animation duration) otherwise true | ||
Returns false if the animation is done (if timeNow >= the animation start time + the animation duration) otherwise true | ||
### License | ||
MIT |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
25027
14
113