From e4a1b9066570456bd74cb8c2ffb4dd0c9342d2e0 Mon Sep 17 00:00:00 2001 From: andris9 Date: Mon, 13 Jun 2011 23:25:48 +0300 Subject: [PATCH] readme update --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6285b8c..c12fda7 100644 --- a/README.md +++ b/README.md @@ -11,14 +11,13 @@ ## Usage var EPub = require("epub"); - var epub = new EPub(epubfile, imagewebroot, chapterwebroot); Where * **epubfile** is the file path to an EPUB file - * **imagewebroot** is the prefix for image URL's. If it's */images/* then the actual URL is going to be */images/IMG_ID/IMG_FILENAME*, `IMG_ID` can be used to fetch the image form the ebook with `getImage` - * **chapterwebroot** is the prefix for chapter URL's. If it's */chapter/* then the actual URL is going to be */chapters/CHAPTER_ID/CHAPTER_FILENAME*, `CHAPTER_ID` can be used to fetch the image form the ebook with `getChapter` + * **imagewebroot** is the prefix for image URL's. If it's */images/* then the actual URL (inside chapter HTML `` blocks) is going to be */images/IMG_ID/IMG_FILENAME*, `IMG_ID` can be used to fetch the image form the ebook with `getImage` + * **chapterwebroot** is the prefix for chapter URL's. If it's */chapter/* then the actual URL (inside chapter HTML `` links) is going to be */chapters/CHAPTER_ID/CHAPTER_FILENAME*, `CHAPTER_ID` can be used to fetch the image form the ebook with `getChapter` Before the contents of the ebook can be read, it must be opened (`EPub` is an `EventEmitter`).