readme

README.md

@@ -0,0 +1,39 @@
+
+Comic Book Reader
+=================
+
+[![Build Status](https://api.travis-ci.org/balaclark/HTML5-Comic-Book-Reader.png)](https://travis-ci.org/balaclark/HTML5-Comic-Book-Reader)
+
+A canvas based web application for reading comics. You can also see an implementation
+of this as an offline Chrome packaged application CBZ / CBR comic book reader at:
+[https://github.com/balaclark/chrome-comic-reader](Chrome Comic Book Reader).
+
+Usage
+-----
+See included examples.
+
+Development Install
+-------------------
+
+Builds require nodejs and npm. Installs have been tested with nodejs 0.10.0, older
+versions may or may not work.
+
+	npm install
+	make
+	make test
+
+Copyright and License
+---------------------
+
+Copyright 2010 Bala Clark
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+this work except in compliance with the License. You may obtain a copy of the
+License in the LICENSE file, or at:
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed
+under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.

lib/ComicBook.js

@@ -4,7 +4,6 @@
   TODOs:
 
   Fo sho:
-    - README with build instructions
     - only trigger navigate event on page change (not resize, etc.)
     - fix manga mode
     - trigger preload if requesting valid but not loaded images (can happen if network was interupted)