diff --git a/README.txt b/README.txt index f8926d4..7be5ce4 100644 --- a/README.txt +++ b/README.txt @@ -42,4 +42,4 @@ README.txt - this file AUTHOR ====== -Copyright Tyler R Dinsmoor 2022 +Copyright Tyler R Dinsmoor 2023 diff --git a/html/index.html b/html/index.html index 6dc74fa..796b17d 100644 --- a/html/index.html +++ b/html/index.html @@ -16,11 +16,11 @@ html{

Usage

URL Root: https://api.1611.social/ (you are here)

Verse searching

@@ -46,9 +46,9 @@ API ENDPOINT SPECIFICATION v 0.2 /random - outputs a random verse /votd - returns verse of the day -/search - returns a keyword search result set (no args is a landing page) +/search - returns a keyword search result set /show - returns a verse or set of verses by name/location -/define - 1828 Noah Webster dictionary (no args is a landing page) +/define - 1828 Noah Webster dictionary URL PARAMETERS ============== @@ -61,6 +61,12 @@ default: json ?kw= - comma-delimited keyword search for /search +INTERACTIVE ENDPOINTS +===================== +/search and /define will show you a landing page where you can +use HTML forms to complete your search. Both of these will +offer you spelling suggestions if it can't find the right word. +This will only offer words that are actually in the Bible. EXAMPLES ======== @@ -69,6 +75,7 @@ api.tld/votd?view=rich api.tld/show?kw=john3:16,1john5:7&view=plain api.tld/search?kw=faith api.tld/search?kw=nimrod&view=rich +api.tld/define?kw=faith&view=rich