diff --git a/ReadMe.md b/ReadMe.md new file mode 100644 index 0000000..2b6d54d --- /dev/null +++ b/ReadMe.md @@ -0,0 +1,45 @@ +![downloads](https://img.shields.io/npm/dm/scroll-to-stick?style=flat-square) +![version](https://img.shields.io/npm/v/scroll-to-stick?color=green&style=flat-square) + +
+ + + +
+ ++ A Javascript way to create parallax header effects. +
+ +## Table of Contents + +- [Introduction](#introduction) +- [Features](#features) +- [Usage](#usage) +- [Feedback](#feedback) + +## Introduction + +If you are building a mobile-first webapp and you would like to have a parallax effect that normally a native app header can have- this tiny simple lib will get your job done. + +## Features + +* Native like parallex effect, simply using Javascript + +* Event driven helper method, to help you do or invoke other customizations when the parallex effect starts and ends + +## Prerequisite + +- Install via [npm](https://www.npmjs.com/)- `npm i scroll-to-stick` + +## Usage + +- Check the [webpage](https://dibosh.github.io/scroll-to-stick/) for detailed usage guide. + + +## Feedback + +Feel free to [file an issue](https://github.com/dibosh/scroll-to-stick/issues/new). + + + diff --git a/index.html b/index.html index 99453b8..c053269 100644 --- a/index.html +++ b/index.html @@ -10,7 +10,7 @@ - +