Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc changes for embeddable viewer #27

Merged
merged 1 commit into from
Jan 10, 2014
Merged

Doc changes for embeddable viewer #27

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ The viewer is the default viewer for Readium.js, a JS library for rendering EPUB

## Getting started
* [Basic EPUB viewer](#basic-epub-viewer)
* [Embeddable EPUB Viewer](#embeddable-epub-viewer)
* [Chrome packaged app](#chrome-packaged-app)
* [Custom EPUB management system](#custom-epub-management-and-viewer-application)
* [Running the Tests](#running-the-tests)
Expand Down Expand Up @@ -59,6 +60,18 @@ Assuming that you have Grunt and project's dependencies already installed (see a

grunt update-readium

### Embeddable EPUB Viewer

You can host an embeddable epub viewer using the same instructions as the [Basic EPUB viewer](#basic-epub-viewer). For example, if you wanted to add epub content to a blog or similar.

Follow the same instructions as setting up the [Basic EPUB viewer](#basic-epub-viewer) then embed the epub reader using an iframe like so

```html
<iframe width="600" height="400" src="http://localhost:8080/simpleviewer.html?epub=epub_content/moby_dick&amp;embedded=true" style="border:1px #ddd solid;" allowfullscreen mozallowfullscreen webkitallowfullscreen></iframe>
```

Note the `embedded=true` query parameter. This adds a special UI and handling for a smaller screen. See the `embed.html` file in the root of the source tree for a complete example that works with the [Basic EPUB viewer](#basic-epub-viewer) setup.

### Chrome Packaged App
To run the chrome packaged app, you will need to do the following:

Expand Down