aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorCamil Staps2015-10-14 22:36:05 +0200
committerCamil Staps2015-10-14 23:02:03 +0200
commitb3caf3f307b4c3f8dcc01258f8ba6f00a3ee5a5a (patch)
tree05575c980e929e720367d5993aef0c1d5eb8233f /README.md
parentUsing Orator migrations (diff)
Parsing bible refs; read commandHEADmaster
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index 6d44631..b113532 100644
--- a/README.md
+++ b/README.md
@@ -22,6 +22,17 @@ You're going to need one or several translations. One possibility is to [get the
$ ./cli.py load --type=biblehub bibles.txt
$ rm bibles.zip bibles.txt
+## Usage
+
+See `./cli.py --help` for general instructions and `./cli.py command --help` for command specific instructions.
+
+## Examples
+
+ $ ./cli.py read 'John 1:1-3' --nl
+ 1:1 In the beginning was the Word, and the Word was with God, and the Word was God.
+ 2 The same was in the beginning with God.
+ 3 All things were made through him; and without him was not anything made that hath been made.
+
## To do
Add a table for cross references, and a script to read in the database from [OpenBible.info][openbibledb].