Sha256: 94760882a04dbeabf3735ef6a8517369026042226db7ab6de634c93b09a081f3

Contents?: true

Size: 1.27 KB

Versions: 1

Compression:

Stored size: 1.27 KB

Contents

EPUB Parser
===========
[![Build Status](https://secure.travis-ci.org/KitaitiMakoto/epub-parser.png?branch=master)](http://travis-ci.org/KitaitiMakoto/epub-parser)

INSTALLATION
-------
    gem install epub-parser  

USAGE
-----

### As a command line tool

    epubinfo path/to/book.epub

For more info:

    epubinfo -h

### As a library

    require 'epub/parser'
    
    book = EPUB::Parser.parse 'book.epub'
    book.each_page_on_spine do |page|
      # do somethong...
    end

See the [wiki][] for more info.
Or [API Documentation][rubydoc].

[wiki]: https://github.com/KitaitiMakoto/epub-parser/wiki
[rubydoc]: http://rubydoc.info/gems/epub-parser/frames

REQUIREMENTS
------------
* libzip for Zip/Ruby gem
* libxml2 and libxslt for Nokogiri gem

TODOS
-----
* Adding tests
* Modify methods around fallback to check bindings element in the package
* Implementing navigation document and so on
* Using SAX on parsing
* Extracting and organizing common behavior from some classes to modules
* Abstraction of XML parser(making it possible to use REXML, standard bundled XML library of Ruby)

DONE
----
* Using zip library instead of `unzip` command, which has security issue

LICENSE
-------
This library is distribuetd under the term of the MIT License.
See MIT-LICENSE file for more info.

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
epub-parser-0.1.0 README.markdown