aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authorYour Name <you@example.com>2020-11-07 07:56:08 -0500
committerYour Name <you@example.com>2020-11-07 07:56:08 -0500
commit67207e20f3dc8b9e92e45560776b5b304f964cc1 (patch)
tree1c766f0869194b2ae0adf4b57d7470140a3a5d6c /readme.md
parent44f16b6cd5b9cd9641c0c5df1c671c9e610ad7ac (diff)
downloadlibbible-67207e20f3dc8b9e92e45560776b5b304f964cc1.tar.gz
libbible-67207e20f3dc8b9e92e45560776b5b304f964cc1.tar.bz2
libbible-67207e20f3dc8b9e92e45560776b5b304f964cc1.zip
Fixed segfaults for invalid module names
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md14
1 files changed, 4 insertions, 10 deletions
diff --git a/readme.md b/readme.md
index 21be739..7eca841 100644
--- a/readme.md
+++ b/readme.md
@@ -4,7 +4,7 @@ This library provides a simplified interface to the SWORD project.
##libbible.so
-The library can be compiled into a sharable object file and installed to the system. This is the default make option:
+The library can be compiled into a sharable object file and installed to the system:
```console
make
@@ -15,16 +15,10 @@ The full interface is available in libbible.h.
##bible
-An example cli is included with libbible, which can be compiled using:
+An example cli is included with libbible. It is designed to showcase the functionality of libbible:
```console
-make bible
-```
-
-The interface is simplistic, and uses a subset of libbible's functionality:
-
-```console
-./bible --help
+bible --help
Usage:
bible [options] [reference]
@@ -42,7 +36,7 @@ Options:
--list-installable=<lang> list bible versions available for download and install. Default lists for all languages.
--install-network <mod> install module from the network where <mod> is LANG:NAME as provided by --list-installable
--install-zip <path> install module from a zip file
- --remove-mod <mod> delete a mod from the system
+ --remove-module <mod> delete a mod from the system
Examples: