Skip to content

Commit

Permalink
Added back build folder for now, updated readme with Gitter
Browse files Browse the repository at this point in the history
  • Loading branch information
fchasen committed Sep 1, 2015
1 parent c41bbd6 commit 2c7c459
Show file tree
Hide file tree
Showing 31 changed files with 27,417 additions and 12 deletions.
4 changes: 1 addition & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,4 @@
*/**/.DS_Store
node_modules/
components
bower_components/
reader/js/
build/
bower_components/
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Epub.js

Epub.js is a JavaScript library for rendering ePub documents in the browser, across many devices.

Epub.js provides an interface for common ebook functions (such as rendering, persistence and pagination) without the need to develop a dedicated application or plugin. Importantly, it has an incredibly permissive [Free BSD](http://en.wikipedia.org/wiki/BSD_licenses) license.
Epub.js provides an interface for common ebook functions (such as rendering, persistence and pagination) without the need to develop a dedicated application or plugin. Importantly, it has an incredibly permissive [Free BSD](http://en.wikipedia.org/wiki/BSD_licenses) license.

[Try it while reading Moby Dick](http://futurepress.github.com/epub.js/reader/)

Expand All @@ -30,7 +30,7 @@ Get the minified code from the build folder:
<script src="../build/epub.min.js"></script>
```

If you plan on using compressed (zipped) epubs (any .epub file) include the minified version of [JSZip.js](http://stuk.github.io/jszip/) + Mime-types which can be found in [build/libs](https://raw.githubusercontent.com/futurepress/epub.js/master/build/libs/zip.min.js)
If you plan on using compressed (zipped) epubs (any .epub file) include the minified version of [JSZip.js](http://stuk.github.io/jszip/) which can be found in [build/libs](https://raw.githubusercontent.com/futurepress/epub.js/master/build/libs/zip.min.js)

```html
<!-- Zip JS -->
Expand Down Expand Up @@ -61,7 +61,7 @@ The [Examples](https://github.com/futurepress/epub.js/tree/master/examples) are
Internet Explorer
-------------------------

Compatibility with IE requires wicked-good-xpath, a Google-authored pure JavaScript implementation of the DOM Level 3 XPath specification. More info at https://code.google.com/p/wicked-good-xpath/
Compatibility with IE is best with wicked-good-xpath, a Google-authored pure JavaScript implementation of the DOM Level 3 XPath specification (but not required). More info at https://code.google.com/p/wicked-good-xpath/

You can download the latest wgxpath [here](https://wicked-good-xpath.googlecode.com/svn/trunk/build/wgxpath.install.js) or from the examples folder.

Expand All @@ -79,7 +79,7 @@ EPUBJS.Hooks.register("beforeChapterDisplay").wgxpath = function(callback, rende
if(callback) callback();
};

wgxpath.install(window);
wgxpath.install(window);
```

There are currently a [number of open issues for Internet Explorer](https://github.com/futurepress/epub.js/labels/Internet%20Explorer) any help addressing them would be greatly appreciated.
Expand Down Expand Up @@ -175,22 +175,24 @@ Example hook:

```javascript
EPUBJS.Hooks.register("beforeChapterDisplay").example = function(callback, renderer){

var elements = render.doc.querySelectorAll('[video]'),
items = Array.prototype.slice.call(elements);

items.forEach(function(item){
//-- do something with the video item
}

if(callback) callback();

}
```
Additional Resources
-------------------------
[![Gitter Chat](https://badges.gitter.im/futurepress/epub.js.png)](https://gitter.im/futurepress/epub.js "Gitter Chat")
[Epub.js Developer Mailing List](https://groups.google.com/forum/#!forum/epubjs)
IRC Server: freenode.net Channel: #epub.js
Expand All @@ -202,5 +204,5 @@ Follow us on twitter: @Epubjs
Other
-------------------------
EPUB is a registered trademark of the [IDPF](http://idpf.org/).
EPUB is a registered trademark of the [IDPF](http://idpf.org/).
8,506 changes: 8,506 additions & 0 deletions build/epub.js

Large diffs are not rendered by default.

27 changes: 27 additions & 0 deletions build/epub.js.map

Large diffs are not rendered by default.

5 changes: 5 additions & 0 deletions build/epub.min.js

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions build/epub.min.map

Large diffs are not rendered by default.

Loading

0 comments on commit 2c7c459

Please sign in to comment.