From 97a34ef812ae06a38d37307ba6415e2e69378595 Mon Sep 17 00:00:00 2001
From: Md Abdul Munim <abdulmunim.buet@gmail.com>
Date: Mon, 3 Aug 2020 17:28:44 +0800
Subject: [PATCH] Add readme

---
 ReadMe.md  | 45 +++++++++++++++++++++++++++++++++++++++++++++
 index.html |  2 +-
 2 files changed, 46 insertions(+), 1 deletion(-)
 create mode 100644 ReadMe.md

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)
+
+<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).
+
+
+
diff --git a/index.html b/index.html
index 99453b8..c053269 100644
--- a/index.html
+++ b/index.html
@@ -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." />