EPUB Reader on your website.

1. How to setup & read/publish EPUB books (for users)

2. How to arrange development environment (for developers)

3. License

4. Special Thanks

5. How to setup & read/publish EPUB books

BiB/i supports two ways to read/publish EPUB books:

• Read in browsers on your local machine, or
• Publish on the web, to have your books read by someone.

In either case, download BiB/i from web site and unzip it at first.

1. Open bib/i/index.html in your browser and
2. Drag an EPUB book and drop it into the window.
3. That's all!

Demo.

You can publish both zipped archive and unzipped folder. (Using unzipped is highly recommended.)

1. Upload bib directory to your web server,
2. Upload your EPUB books(for instance, my-book.epub here) to bib/bookshelf directory, and
3. Access to http://your.web.site/bib/i/?book=my-book.epub by your browser.
4. Or embed code below into your blog and visit the blog entry.

<a href="http://your.web.site/somewhere/bib/i/?book=my-book.epub" data-bibi="embed" data-bibi-style="[[ CSS for embeded BiB/i, as you like ]]">My Great Book Title</a><script src="http://your.web.site/bib/i.js"></script>

You may also read EPUB books as unzipped archives, or by page-by-page access, by uploading unzipped EPUB books to bookshelf directory. This is recommended because it accelarates reading experience of your readers.

1. Unzip an EPUB book,
   1. Change the file extension from .epub to .zip (my-book.epub -> my-book.zip) and then
   2. unzip the file with some tool.
2. Upload it to bib/bookshelf directory, and
3. Visit http://your.web.site/bib/i/?book=my-book (note that it has No Extension) or embed code for it.

<a href="http://your.web.site/somewhere/bib/i/?book=my-book" data-bibi="embed" data-bibi-style="[[ CSS for embeded BiB/i, as you like ]]">My Great Book Title</a><script src="http://your.web.site/bib/i.js"></script>

2. How to arrange development environment

1. Node.js + npm - guide: “Download the installer” (or “Installing Node.js via package manager”)
2. Ruby (+ RubyGems) - guide: “Installing Ruby” (+ “RubyGems Basics”)
3. Bundler - how to install: $ gem update --system and $ gem install bundler
4. Grunt - how to install: $ npm install -g grunt-cli ... (“Getting Started”)

1. Clone this repository. (https://github.com/satorumurmur/bibi/)
2. $ cd <the repository>
3. $ bundle install --path=vendor/bundle -> vendor/bundle directory including RubyGems (Compass and dependent gems) is installed.
4. $ npm install -> npm-modules directory including modules is installed.

1. $grunt build and renew these files. Or $ grunt and start watching changes of files for development, and renew these files:
   • bib/i/res/scripts/bibi.js
   • bib/i/res/styles/bibi.css
   • bib/i.js
   • bib/i.css
2. Edit files.
   • SCSS source files of bib/i/res/styles/bibi.css and bib/i/res/styles/pipi.css are in dev-bib/i/res/styles/.
   • JavaScript source files of bib/i/res/scripts/bibi.js are in dev-bib/i/res/scripts/.
   • JavaScript source file of bib/i.js is dev-bib/i/res/scripts/pipi.js.
3. Run web server for dynamic-compiling.
   • $ bundle exec rackup
   • A server starts listening port 9292 by default.
   • The server returns compiled CSS of dev-bib/styles/*.scss to request.

Following files are not watched or processed by Grunt tasks:

• bib/i/index.html (as portal)
• bib/i.js (for embedding in HTML webpage)
• bib/manifest.json (for using as Chrome application)
• Files in bib/presets/ (customisable settings and styles)
• Files in bib/i/res/fonts/ (icon fonts)

And bib/bookshelf/ directory is including .gitkeep

3. License

• © Satoru MATSUSHIMA - http://bibi.epub.link/ or https://github.com/satorumurmur/bibi
• Licensed under the MIT license. - http://www.opensource.org/licenses/mit-license.php

• JSZip ... © Stuart Knightley (Dual licensed under the MIT license or GPLv3.)
• base64.js ... © dankogai (Licensed under the MIT license.)
• Native Promise Only ... © Kyle Simpson (Licensed under the MIT license.)
• Hammer.js ... © Jorik Tangelder (Licensed under the MIT license.)
• easing.js ... © Dan Rogers (Licensed under the MIT license.)
• sML ... © Satoru MATSUSHIMA (Licensed under the MIT license.)
• The Elegant Icon Font ... © Elegant Themes, Inc. (Dual licensed under the GPL 2.0 and the MIT license.)

4. Special Thanks

• KITAITI Makoto ... @KitaitiMakoto
• Shunsuke Ito ... @shunito