Update Reference Universe widget documentation.
[mkws-moved-to-github.git] / examples / htdocs / mkws-widget-ru.readme
index c55272e..9fd05da 100644 (file)
@@ -5,8 +5,9 @@ Simply paste this inline with the markup on any page:
 
     <script src="//mkws.indexdata.com/mkws-complete.js"></script>
     <script src="//mkws.indexdata.com/mkws-widget-ru.js"></script>
+    <script>var mkws_config = { sp_auth_credentials: "paratext/paratext_mkc" }</script>
     <link rel="stylesheet" type="text/css" href="//mkws.indexdata.com/mkws-widget-ru.css" />
-    <div class="mkwsReferenceUniverse" autosearch="!param!q"></div>
+    <div class="mkws-reference-universe" autosearch="!param!q"></div>
     
 ## A bit more detail 
 
@@ -17,13 +18,17 @@ You need to include two scripts: one for MKWS and one for the Reference Universe
     <script src="//mkws.indexdata.com/mkws-complete.js"></script>
     <script src="//mkws.indexdata.com/mkws-widget-ru.js"></script>
     
+You also need to tell the widget how to authenticate onto the searching service:
+
+    <script>var mkws_config = { sp_auth_credentials: "paratext/paratext_mkc" }</script>
+
 The provided stylesheet is generic and you're encouraged to replace it entirely by styling the new elements to fit seamlessly with your content. 
 
     <link rel="stylesheet" type="text/css" href="//mkws.indexdata.com/mkws-widget-ru.css" />
     
-Any element you give the class `mkwsReferenceUniverse` will have is contents replaced by the top results from a search against the Reference Universe service for the current query.
+Any element you give the class `mkws-reference-universe` will have is contents replaced by the top results from a search against the Reference Universe service for the current query.
     
-    <div class="mkwsReferenceUniverse" autosearch="!param!q"></div>
+    <div class="mkws-reference-universe" autosearch="!param!q"></div>
 
 ### Finding the query