Library compatibility
This library works for IE8+, Mozilla Firefox 4+, Google Chrome 11+, Opera 10+, Safari 4+.
diff --git a/README.md b/README.md index 766f08e..85d2d39 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ # floativ -floativ is a floating scroll-box at the bottom of the screen of your site that contains text, among other things, which can be displayed while browsing a web page. This floating scroll-box disappears when the user reaches an element with a specific id. +floativ is a responsive floating scroll-box at the bottom of the screen of your site that contains text, among other things, which can be displayed while browsing a web page. This floating scroll-box disappears when the user reaches an element with a specific id. ## Installation 1. Download and install [NodeJS](https://nodejs.org/) -2. Clone or Download project straight from GitHub. +2. Clone or Download project straight from [GitHub](https://github.com/GBratsos/floativ). 3. Extract the zip file and start working. ## Directions @@ -13,7 +13,33 @@ floativ is a floating scroll-box at the bottom of the screen of your site that c ## NPM Package You can find and install floativ from npm [here](https://www.npmjs.com/package/floativ). -## Library Compatibility +## Usage +Put this `$("#floativ").floativ();` inside __script tags__ at the bottom of your HTML file. +You can also specify parameters, such as: +```html +
This library works for IE8+, Mozilla Firefox 4+, Google Chrome 11+, Opera 10+, Safari 4+.