turn.js/readme.md
Andrea Gherardi fd058cfa8c Update readme
2017-01-16 16:32:18 +01:00

25 lines
719 B
Markdown
Executable File

A fork of [https://github.com/blasten/turn.js](https://github.com/blasten/turn.js)
with support for npm/yarn.
Usage:
```
import $ from 'jquery';
import 'turn.js';
$('#flipbook').turn({
width: 800,
height: 600,
autoCenter: true
// ... plus any extra option you need
});
```
Basically I just added a package.json file and specified a main entry point + a
dependency (jquery) to make turn.js installable via npm/yarn.
I have submitted a PR to the authors of [https://github.com/blasten/turn.js](https://github.com/blasten/turn.js) but in the meantime you can use this one, as they don't seem to update their repo regularly.
Latest version uses jQuery 1.12.0 because jQuery 3.x was breaking the page
flipper.