Skip to content

Commit 2c7c459

Browse files
committed
Added back build folder for now, updated readme with Gitter
1 parent c41bbd6 commit 2c7c459

31 files changed

+27417
-12
lines changed

.gitignore

+1-3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,4 @@
22
*/**/.DS_Store
33
node_modules/
44
components
5-
bower_components/
6-
reader/js/
7-
build/
5+
bower_components/

README.md

+11-9
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Epub.js
55

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

8-
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.
8+
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.
99

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

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

33-
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)
33+
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)
3434

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

64-
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/
64+
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/
6565

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

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

82-
wgxpath.install(window);
82+
wgxpath.install(window);
8383
```
8484

8585
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.
@@ -175,22 +175,24 @@ Example hook:
175175

176176
```javascript
177177
EPUBJS.Hooks.register("beforeChapterDisplay").example = function(callback, renderer){
178-
178+
179179
var elements = render.doc.querySelectorAll('[video]'),
180180
items = Array.prototype.slice.call(elements);
181-
181+
182182
items.forEach(function(item){
183183
//-- do something with the video item
184184
}
185-
185+
186186
if(callback) callback();
187-
187+
188188
}
189189
```
190190
191191
Additional Resources
192192
-------------------------
193193
194+
[![Gitter Chat](https://badges.gitter.im/futurepress/epub.js.png)](https://gitter.im/futurepress/epub.js "Gitter Chat")
195+
194196
[Epub.js Developer Mailing List](https://groups.google.com/forum/#!forum/epubjs)
195197
196198
IRC Server: freenode.net Channel: #epub.js
@@ -202,5 +204,5 @@ Follow us on twitter: @Epubjs
202204
Other
203205
-------------------------
204206
205-
EPUB is a registered trademark of the [IDPF](http://idpf.org/).
207+
EPUB is a registered trademark of the [IDPF](http://idpf.org/).
206208

build/epub.js

+8,506
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

build/epub.js.map

+27
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

build/epub.min.js

+5
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

build/epub.min.map

+1
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)