diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..2844ab8 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +.idea +/bourbon/* +/.sass-cache/* +*.DS_Store +/nbproject/ \ No newline at end of file diff --git a/README.md b/README.md index ea151f7..d6cf5cc 100644 --- a/README.md +++ b/README.md @@ -8,3 +8,16 @@ An easy to customize, responsive timeline. [Demo](http://codyhouse.co/demo/vertical-timeline/index.html) [Terms](http://codyhouse.co/terms/) + +### Usage via JavaScript + +Call a `TimeLine.enable(options);` when DOM is fully loaded to activate animated fade-in of vertical-timeline blocks. + +## Options + +Available options: + +| Name | type | default | description | +| ------------- | ------ | ------------------ | -------------------------------------- | +| timelineBlock | string | .cd-timeline-block | Class name of timeline-block | +| scrollElement | string | window | Selector name to bind the scroll event | \ No newline at end of file diff --git a/index.html b/index.html index c8e9fcb..a410ee5 100644 --- a/index.html +++ b/index.html @@ -96,6 +96,7 @@