Update README doc

hotoo · Sep 25, 2014 · f0ee558 · f0ee558
1 parent baf3556
commit f0ee558
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -17,3 +17,18 @@ var Markline = require('markline');
 var line = new Markline("#timeline", "./data/timeline.md");
 line.render();
 ```
+
+## API
+
+### Markline(Object element, String filePath)
+
+Markline Constuctor.
+
+Params:
+
+* `Object element`: markline container element, Need HTMLElement, jQuery Object, or Selector.
+* `String filePath`: markdown file path to be used.
+
+### markline.render()
+
+Render timeline into container.