Add sample use case.

swashcap · Apr 15, 2015 · a92a9b1 · a92a9b1
1 parent 594261e
commit a92a9b1
Showing 1 changed file with 21 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,21 @@
-# jquery-canvas-animation
-Easy canvas image sequence animation wrapped in a jQuery pluign.
+# jQuery Canvas Animation
+
+_Easy canvas image sequence animation wrapped in a jQuery plugin._
+
+## Plugin Use
+
+Use the plugin like so:
+
+```js
+$('#my-canvas').canvasAnimation({
+    frameInterval: 1000 / 60,
+    images: [
+        '/path/to/image-001.jpg',
+        '/path/to/image-002.jpg',
+        '/path/to/image-003.jpg',
+        // ...
+        '/path/to/image-100.jpg'
+    ],
+    imageRatio: 640 / 320,
+});
+```