Updated readme

ftlabs · May 8, 2013 · 45da8fd · 45da8fd
1 parent b419e0b
commit 45da8fd
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 2 deletions.
diff --git a/GruntFile.js b/GruntFile.js
@@ -11,7 +11,7 @@ module.exports = function(grunt) {
       },
       dist: {
         src: [
-          'lib/ellipsis.js'
+          'lib/index.js'
         ],
         dest: 'README.md'
       }

diff --git a/README.md b/README.md
@@ -62,6 +62,42 @@ $ npm test
 ```
 
 ## API
+### Ellipsis();
+
+Initialize a new Ellipsis
+instance with the given element.
+
+Options:
+
+ - `container` A parent container element
+ - `reRender` Forces a redraw after ellipsis applied
+
+### Ellipsis#calc();
+
+Measures the element and
+finds the overflowing child.
+
+
+
+### Ellipsis#set();
+
+Clamps the overflowing child using
+the information acquired from #calc().
+
+
+
+### Ellipsis#unset();
+
+Unclamps the overflowing child.
+
+
+
+### Ellipsis#destroy();
+
+Clears any references
+
+
+
 
 
 ## Credits and collaboration

diff --git a/docs/wrapper.hogan b/docs/wrapper.hogan
@@ -62,7 +62,7 @@ $ npm test
 ```
 
 ## API
-{{{ellipsis}}}
+{{{index}}}
 
 ## Credits and collaboration