From b07425b4b2f08dcc575fa138aee3270b84444775 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christopher=20John=20Duncan=20Ara=C3=BAz?= Date: Thu, 5 May 2016 11:23:56 -0500 Subject: [PATCH] Add default settings to the constructor class I noticed in epub.js that the values 'imagewebroot' and 'chapterwebroot' have default values, so I specified them in the documentation. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 918c75f..e38daeb 100644 --- a/README.md +++ b/README.md @@ -21,8 +21,8 @@ Or, if you want a pure-JS version (useful if used in a Node-Webkit app for examp 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 (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` + * **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`. Default: `/images/` + * **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`. Default: `/links/` Before the contents of the ebook can be read, it must be opened (`EPub` is an `EventEmitter`).