diff --git a/package.json b/package.json index e48b2c2..04ec6cd 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "turn.js", - "version": "1.0.3", + "version": "1.0.4", "description": "Web page flipper", "main": "index.js", "repository": "https://github.com/igghera/turn.js.git", diff --git a/readme.md b/readme.md index 44cf224..976493a 100755 --- a/readme.md +++ b/readme.md @@ -1,4 +1,24 @@ - A fork of [https://github.com/blasten/turn.js](https://github.com/blasten/turn.js) -with support for npm/yarn. Basically I just added a package.json file and -specified a main entry point + a dependency (jquery) +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.