Skip to content

Update README.md #20

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.

Sign up for GitHub

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

Open
Lan5880 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #20

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
### Makisu
## Makisu

An experimental CSS 3D dropdown concept, wrapped up in a [jQuery](http://jquery.com/) plugin.

Check out the [demo](http://soulwire.github.com/Makisu/) _(you'll need a CSS 3D capable browser, such as [Chrome](www.google.com/chrome).)_

A current list of supported browsers can be found [here](http://caniuse.com/#search=3d%20transform).

#### Example usage
### Example usage

Use it like any regular jQuery plugin:

Expand All @@ -24,12 +24,12 @@ The options available are:
- `shading` Default shading colour (`null` for no shading)
- `perspective` Perspective to apply to 3D transformed objects

#### API
## API

Once an element has been extended as in the example above, you can `open`, `close` and `toggle` it.

$( '.list' ).makisu( 'open' );

#### Trivia
## Trivia

The name comes from the [object](http://en.wikipedia.org/wiki/Makisu) that inspired it.