transient - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

README.md

+# Transient
+
+A simple and minimal animation loop.  Consistant frame rate is attempted with independant progress timing and requestAnimationFrame.  This library is great for simple transition animations, thus the name, but can also be used to complex animations.
+
+Usage:
+
+```javascript
+var animation = require('transient');
+
+var el = document.getElementById('.my-element');
+
+// Create the animation
+var fadeIn = new animation({
+	duration: 1500, // 1.5 seconds
+	draw: function(progress) {
+		// progress is an integer between 0 and 1
+		el.style.opacity = progress;
+	}
+});
+
+// Start the animation
+fadeIn.start();
+```
+
+Options:
+
+- `duration`: The animation duration in milliseconds. default: `5000`
+- `fps`: Consistant frames per second for the animation. default: `60`
+- `loop`: Should the animation loop? default: `false`
+- `draw`: The draw function which is called for each loop.
+- `onEnd`: A function to call when the animation is finished.
+- `onCancel`: A function to call when the animation is canceled.  If this is not specified it will call the `onEnd` function

package.json

 {
   "name": "transient",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "An animation loop implementation",
@@ -5,0 +5,0 @@ "main": "index.js",

Fixed alerts

No README

Quality

Package does not have a README. This may indicate a failed publish or a low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

3602

41.98%

Number of package files

5

25%

Number of medium quality alerts

1

-50%

Number of lines in readme file

33

Infinity%

No dependency changes