Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jleaders authored Oct 29, 2019
1 parent e654559 commit 59fa646
Showing 1 changed file with 28 additions and 5 deletions.
33 changes: 28 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Photo Images Plugin

**This README.md file should be modified to describe the features, installation, configuration, and general usage of the plugin.**

The **Photo Images** Plugin is an extension for [Grav CMS](http://github.com/getgrav/grav). Grav Plugin - Applies photograph "printed" effect to images (frame, shadow and rotation) via [ultrix3x/JQueryPhotoImages](http://github.com/ultrix3x/JQueryPhotoImages)

## Installation
Expand Down Expand Up @@ -44,13 +42,38 @@ Note that if you use the Admin Plugin, a file with your configuration named phot

## Usage

**Describe how to use the plugin.**
Simply add the `frame-tilt` CSS class to an image, i.e.:

![alt text](myimage.jpg?classes=frame-tilt)

or

<img src='mypage/myimage.jpg' class='frame-tilt'>

You can control the parameters like this:

<script>
jQuery(document).ready(function() {
// Create photoImages with a seed-based rotation
jQuery('.my-frame-tilt').photoImages({
boxShadowOffsetX: '10px',
boxShadowOffsetY: '10px',
boxShadowLength: '10px',
boxShadowColor: '#7f7f7f',
marginRight: '10px',
rotate: 'seed'
});
});
</script>
Then use `my-frame-tilt` class

## Credits

**Did you incorporate third-party code? Want to thank somebody?**
* Grav plugin by Jonathan Leaders
* Original photo image code by [ultrix3x/JQueryPhotoImages](http://github.com/ultrix3x/JQueryPhotoImages)

## To Do

- [ ] Future plans, if any
- [ ] Upgrade functionality to support a firstclass parameter which sets the degrees of rotation ?framerot=15

0 comments on commit 59fa646

Please sign in to comment.