Skip to content

Commit

Permalink
Add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
itsmunim committed Aug 3, 2020
1 parent 603f922 commit 97a34ef
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 1 deletion.
45 changes: 45 additions & 0 deletions ReadMe.md
Original file line number Diff line number Diff line change
@@ -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)

<p align="center">
<a href="https://github.com/dibosh/kustron">
<img alt="scroll to stick" title="scroll to stick" src="www/assets/icon_sts.png" width="200">
</a>
</p>

<p align="center">
A Javascript way to create parallax header effects.
</p>

## 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).



2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<link rel="stylesheet" href="www/styles/common.css">
<link rel="stylesheet" href="www/styles/home.css">

<meta name="description" content="A Javascript way to creatr parallax header effects.">
<meta name="description" content="A Javascript way to create parallax header effects.">
<meta name=viewport content="width=device-width, initial-scale=1">
<meta property="og:title" content="ScrollToStick" />
<meta property="og:description" content="A Javascript way to create parallax header effects." />
Expand Down

0 comments on commit 97a34ef

Please sign in to comment.