Skip to content

Commit

Permalink
Upd: Doc and listed features
Browse files Browse the repository at this point in the history
  • Loading branch information
vin-ai committed Mar 14, 2016
1 parent 3ec5904 commit 410d868
Showing 1 changed file with 20 additions and 8 deletions.
28 changes: 20 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,25 @@
# jQuery Smartify

jQuery Smartify loads images, calls Ajax, plays with css classes in on demand, while element is/or becoming visible in device Viewport.
jQuery Smartify boosts web application load times and loads images, calls Ajax, plays with css classes in/on demand, while element is/or being visible in device Viewport.

It has full capability of [jQuery Lazyload](https://github.com/tuupola/jquery_lazyload), but with more elements coverage and advanced. This doesn't only work for <img>, have capabality to smartify every thing!
It has full capability of [jQuery Lazyload](https://github.com/tuupola/jquery_lazyload), but with more elements coverage and advanced. This doesn't only work for <img>, have capabality to smartify any elements!

Plugin is inspired by [jQuery Lazyload](https://github.com/tuupola/jquery_lazyload) created by [Mika Tuupola](https://github.com/tuupola).

### Plans & Features
### Features, Benefits & Plans

- [ ] Multiple Elements Support
- [ ] Multiple Source for High Res(Retina) devices
- [x] Boost your web application load time.
- [x] Multiple Elements Support
- [x] Dynamically load contents via Ajax call. e.g: Load each section on just before becoming visible.
- [x] Infinite load items, such as products to sale. Best for e-commerce websites.
- [x] Load images when visible in viewport.
- [x] Load dynamic images for different DPI supports. Such as 3x for High Res(Retina) display.
- [x] Toggle, Add or Remove element classes.
- [x] Or just call User defined callback function.
- [ ] HTML5 History API (wip)

## Getting Started

Download the [production version][min] or the [development version][max].

[min]: https://raw.github.com/vinaykrsharma/jquery.smartify/master/dist/jquery.smartify.min.js
Expand All @@ -21,10 +29,14 @@ In your web page:

```html
<!--
HTML AND ELEMENT HERE TO TARGET BY SMARTIFY
FOR DETAILS SEE DEMO
Elements to Smartify
-->
<script src="jquery.js"></script>
<img class="smartify" sm-src="/static/path/to/img.png">

...

<!-- JavaScript before </body> -->
<script src="//cdnjs.cloudflare.com/ajax/libs/jquery/2.1.4/jquery.min.js"></script>
<script src="dist/jquery.smartify.min.js"></script>
<script>
jQuery(function($) {
Expand Down

0 comments on commit 410d868

Please sign in to comment.