Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Markdown Syntax #4

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions readme.md → README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
#Rotating Heads
# Rotating Heads

This plugin was written for use in the [Anthropose](http://anthropose.com/product/aristle/) website in order to show how sunglasses would look like. This is actually a very low tech solution to a virtual try-on implemented in the Rayban website and is heavily inspired from the [Warby Parker](https://www.warbyparker.com/) website.

##General Idea
## General Idea
1. The general idea in this plugin is to use a [sprite image](https://developer.mozilla.org/en-US/docs/Web/Guide/CSS/CSS_Image_Sprites) so that all angles are loaded simultaneously.
2. If the number of images are 5 then the container is also divided into 5 parts.
3. Hover on each part of the container will change the background position of the sprite to match accordingly.

##Options
###Options include:
## Options
### Options include:
1. total_banner_width in pixels *(width of entire sprite )*
2. total_width in pixels *(width of each individual item image in sprite)*
3. Number of images is the number of seperate blocks within the sprite image.

##Usage
## Usage
1. Using defaults
> $("#rotate-container").rotateHeads();

Expand Down