README.md in gepub-0.6.2 vs README.md in gepub-0.6.3

- old
+ new

@@ -7,18 +7,51 @@ a generic EPUB parser/generator library. ## FEATURES/PROBLEMS: * GEPUB::Book provides functionality to create EPUB file, and parsing EPUB file -* from version 0.6, GEPUB::Book will be able handle almost every metadata in EPUB2/EPUB3. - .. but is still beta version. Please inform me when you find bugs. -* Will provide easy to generate EPUB class, like Nokogiri::XML::Generator. +* Handle every metadata in EPUB2/EPUB3. +* Soon, I will provide easy to generate EPUB class, like Nokogiri::XML::Generator. * See [issues](https://github.com/skoji/gepub/issues/) for known problems. ## SYNOPSIS: -see examples directory. +### Builder Example + + require 'rubygem' + require 'gepub' + workdir = 'epub/example/' + builder = GEPUB::Builder.new { + unique_identifier 'http:/example.jp/bookid_in_url', 'BookID', 'URL' + language 'en' + + title 'GEPUB Sample Book' + subtitle 'This book is just a sample' + alt 'ja' => 'これはあくまでサンプルです' + + creator 'KOJIMA Satoshi' + alt 'ja' => '小嶋智' + + contributors 'Denshobu', 'Asagaya Densho', 'Shonan Densho Teidan', 'eMagazine Torutaru' + + date '2012-02-29T00:00:00Z' + + resources(:workdir => workdir) { + cover_image 'img/image1.jpg' => 'image1.jpg' + ordered { + file 'text/chap1.xhtml' + heading 'Chapter 1' + file 'text/chap1-1.xhtml' + file 'text/chap2.html' + heading 'Chapter 2' + } + } + } + epubname = File.join(File.dirname(__FILE__), 'example_test_with_builder.epub') + builder.generate_epub(epubname) + + [examples](https://github.com/skoji/gepub/tree/master/examples/) ## INSTALL: * gem install gepub