From 71891d83621f77ec087f25bc08739bcc5a761b23 Mon Sep 17 00:00:00 2001 From: Tyler Date: Fri, 13 Jan 2023 14:40:43 -0800 Subject: [PATCH] fixed index documentation --- index.html | 22 +++++++--------------- 1 file changed, 7 insertions(+), 15 deletions(-) diff --git a/index.html b/index.html index d3554d6..6dc74fa 100644 --- a/index.html +++ b/index.html @@ -20,28 +20,20 @@ html{
  • /votd - A random verse that changes from day-to-day.
  • /search - Search keywords
  • /show - Show a set of verses
  • -
  • /define - Show a set of verses
  • +
  • /define - Search the Dictionary
  • Verse searching

    -

    '/show?kw=' will try to match single verses and verse ranges. For example:

    +

    '/show?kw=' will try to match single verses and verse ranges. (not sets) For example:

     
    -/search?kw=john3:16
    -/search?kw=John 3:13-18
    -/search?kw=2 Peter 2:8
    -/search?kw=1 John 3:3- (gets the whole rest of the chapter)
    -/search?kw=ecc 2:1-
    +/show?kw=john3:16
    +/show?kw=1 John 3:3- (gets the whole rest of the chapter)
     
     

    Keyword searching

    '/search?kw=keyword' accepts a search word, and will return any verses matching the query. For example:

    -
    -
    -
    -
    -

    Integration

    If you want to put the verse of the day into your website, you can use the following example php:

    @@ -54,8 +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 +/search - returns a keyword search result set (no args is a landing page) /show - returns a verse or set of verses by name/location +/define - 1828 Noah Webster dictionary (no args is a landing page) URL PARAMETERS ============== @@ -67,8 +60,7 @@ default: json ?kw= - comma-delimited keyword search for /search -search default: faith -show default: john3:16 + EXAMPLES ========