Permalink
Browse files

updated README

  • Loading branch information...
1 parent 5af530b commit 992063ed9d7f259300abf74b5e43b92bae06dc61 @Vaporbook committed Dec 4, 2012
Showing with 6 additions and 2 deletions.
  1. +5 −1 README.md
  2. +1 −1 package.json
View
@@ -8,4 +8,8 @@ Provides reading system templates, single HTML file templates for viewing Epub c
# Design
-The design of this module is dependent on a few assumptions: the reading systems here are meant to be fast, compact, lightweight, and heavily optimized for single file usage. The configuration for particular epub content is meant to be injected into the template. All CSS, Javascript and graphical assets should be packaged within this file. Assets can be worked with in separate files but the final template must be a single html file, minified, with a single line on its own for configuration injection.
+The design of this module is dependent on a few assumptions: the reading systems here are meant to be fast, compact, lightweight, and heavily optimized for single file usage. The configuration for particular epub content is meant to be injected into the template. All CSS, Javascript and graphical assets should be packaged within this file. Assets can be worked with in separate files but the final template must be a single html file, minified, with a single line on its own for configuration injection.
+
+# Huh?
+
+Right now, you will most likely want to add your own external templates for testing. At some point, external templates may be incorporated into it. Use the addTemplate function to add your template html. You can use the template in the html/read/ subdir as a starting point.
View
@@ -1,6 +1,6 @@
{
"name": "epub-tmpl",
- "version": "0.1.0",
+ "version": "0.1.1",
"description": "Serve up reading system templates for epub2web epub reader",
"main": "index.js",
"scripts": {

0 comments on commit 992063e

Please sign in to comment.