From 5c25c2834396d98a0c23bf036b94c8f6f5744379 Mon Sep 17 00:00:00 2001 From: Scott Williams Date: Fri, 22 Feb 2019 15:23:31 -0800 Subject: [PATCH] Add info for setting the API key and example message. --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 70f3864..699c841 100644 --- a/README.md +++ b/README.md @@ -18,11 +18,15 @@ Then add **hubot-esv** to your `external-scripts.json`: ] ``` +This plugin requires an API key from api.esv.org. Set this +as HUBOT_ESV_API_KEY in the hubot environment. +An API key can be obtained at https://api.esv.org/account/create-application/ + ## Sample Interaction ``` -user1>> hubot hello -hubot>> hello! +user1>> hubot esv John 3:16 +hubot>> [16] “For God so loved the world, that he gave his only Son, that whoever believes in him should not perish but have eternal life. (ESV) ``` ## NPM Module