aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorzefanja <zefanja@freenet.de>2013-10-07 15:12:28 +0700
committerzefanja <zefanja@freenet.de>2013-10-07 15:12:28 +0700
commit9bf4f9dacd2bc4e8ceb86c9fa4e26e375e277449 (patch)
treef4a00c9cfb3c65dd8f2bb16cf89f80668e004fdb
parentb15e308f873807053cb5de82bf950e1d5cfb3f37 (diff)
downloadbiblez-ng-9bf4f9dacd2bc4e8ceb86c9fa4e26e375e277449.tar.gz
* updated README
-rw-r--r--README.md17
1 files changed, 13 insertions, 4 deletions
diff --git a/README.md b/README.md
index 73269e0..06eb766 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,15 @@
-bootplate
-=========
+# BibleZ NG #
+BibleZ NG is an web app for Firefox OS. It is based on [swordjs](https://github.com/zefanja/swordjs) and [EnyoJS](http://enyojs.com).
-Application template for packaged Enyo
+The main goals are:
+ * provide offline access to bible modules in many different languages (BibleZ NG is build upon the modules from [CrossWire](http://crosswire.org/sword)).
+ * easy-to-use interface
+ * great features like search, personal note and bookmarks/highlights, commentaries and more
-Refer to the [Wiki](https://github.com/enyojs/enyo/wiki/Bootplate) for how to get started.
+Currently you can use BibleZ NG for basic reading on your FxOS device.
+
+## How to build the app ##
+Just run ```./buildApp.sh``` from the root folder and you will have the app in the ```deploy/biblez-ng/``` folder.
+
+## Licence ##
+BibleZ NG is licenced under GPL v3.