Skip to content

Commit

Permalink
update README and versions
Browse files Browse the repository at this point in the history
  • Loading branch information
Geoffrey Signorato committed Mar 15, 2018
1 parent 4adb52f commit e67f7cb
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 5 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,19 +74,29 @@ You can apply these settings with the following jQuery code:
$('img').simpleParallax({scale: '1.30', orientation: 'down'});
```

## 4. Good to know
## 4. Methods

Find below the different methods you can use:

### destroy

```javascript
$('.thumbnail').data('simpleParallax').destroy();
```

# Good to know

* The higher the scale setting is set, the more visible the parallax effect will be. In return, the image will lose in quality.

* This plugin apply parallax on the image tag and not the background image. This gives you a lot of flexibility and can be added to any image.

* You can apply simpleParallax on picture/srcset images

## Author
# Author

[Geoffrey Signorato](https://github.com/geosenna/)

## Contributing
# Contributing

Open an issue or a pull request to suggest changes or additions.

Expand Down
2 changes: 1 addition & 1 deletion bower.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "simpleParallax",
"description": "simpleParallax is a simple and lightweight jQuery plugin that gives your website parallax animations on the images",
"version": "2.1.0",
"version": "2.2.0",
"main": "src/simpleParallax.js",
"authors": [
"Geoffrey Signorato <[email protected]>"
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "simple-parallax-jquery",
"version": "2.1.0",
"version": "2.2.0",
"description": "simpleParallax is a simple and lightweight jQuery plugin that gives your website parallax animations on the images",
"homepage": "https://anakao-theme.com/simpleparallax/",
"main": "src/simpleParallax.js",
Expand Down

0 comments on commit e67f7cb

Please sign in to comment.