first commit

README.txt

@@ -0,0 +1,44 @@
+KJV-API
+=======
+King James Version web API is a machine and human callable service to
+query the King James Bible and provides useful features, such as random
+verses and a quote of the day.
+
+
+EXTERNAL DATA
+=============
+The software uses these JSON data stores as external dependancies, saved locally (included)
+https://github.com/scrollmapper/bible_databases/blob/master/json/t_kjv.json
+https://github.com/scrollmapper/bible_databases/blob/master/json/key_english.json
+
+For additional dependancies see INSTALL.txt
+
+
+INSTALLATION
+============
+See INSTALL.TXT
+
+USAGE
+=====
+The program may be invoked by running kjv-api.sh in a non-root account, or via
+systemd daemon process in a non-root account.
+Alternately for testing, the program may be run on another port by running:
+$ uwsgi_python3 --http-socket <listen address>:<port> --wsgi-file /opt/kjv-api/app.py --callable app
+
+Visiting the base directory will show the user-facing documentation via web browser or cURL.
+
+CONTENTS
+========
+app.py - main flask program
+install/ - folder containing sample configurations
+key_english.json - King James Bible books by index in JSON
+t_kjv.json - King James Bible in JSON
+index.html - root document help file - user-facing documentation
+INSTALL.txt - detailed installation instructions
+kjv-api.sh - script that properly runs flask through uwsgi
+README.txt - this file
+
+
+AUTHOR
+======
+Copyright Tyler R Dinsmoor 2022