diff --git a/README.md b/README.md index ce9ed4c..f72c4a7 100644 --- 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.