Merge pull request #4 from SarahZum/readme-edits

Readme edits

Author: SarahZum

README.md

@@ -1,7 +1,17 @@
 # primo-browzine
 Integrate Browzine's Article DOI Lookup and Journal Availability endpoints into Primo interface.
 
-Requirements:  Browzine subscription and API Key + Customer Number.
+Requirements:  
+* Browzine subscription and API Key + Customer Number.
+* Access to Customization Manager files for the new Primo UI.
+* Local server to host Node.js scripts
 
 This project uses Node.js on a non-Primo server to query Browzine's APIs and return the data to Primo for display in results that contain journals (with an ISSN) or journal articles (with a DOI).
 
+To implement:
+
+1. Set up the Node.js scripts on a local server.  Browzine can provide some assistance with this step.  I tested using Amazon's Lambda service and an API gateway.  For production, St. Olaf is using a local server and ColdFusion component.  I've included that code if you happen to be a CF shop.
+   1. stoKey and stoID refer to your Browzine API key and customer number.  They should be updated to reflect your institution's keys.  Contact [Browzine](http://support.thirdiron.com/knowledgebase/articles/1127656-browzine-api-functionality) to obtain credentials.
+1. Add the browzine.js code to the custom.js file in your [Customization Package](https://knowledge.exlibrisgroup.com/Primo/Product_Documentation/New_Primo_User_Interface/New_UI_Customization_-_Best_Practices#Using_the_UI_Customization_Package_Manager).  You will need to update the "nodeserver" constant with the URI for the server running the Node scripts.
+1. Add the browzine.css lines to custom1.css file in your [Customization Package](https://knowledge.exlibrisgroup.com/Primo/Product_Documentation/New_Primo_User_Interface/New_UI_Customization_-_Best_Practices#Using_the_UI_Customization_Package_Manager).
+1. Deploy the Customization Package on your Primo server.

css/browzine.css

@@ -0,0 +1,11 @@
+/* Browzine styles */
+.browzine-icon  {
+  margin-right:2px;
+}
+
+.browzine-external-link {
+  width:15px;
+  height:15px;
+  min-width:15px;
+  min-height:15px;
+}

js/browzine.js

@@ -35,9 +35,9 @@
     bindings: { parentCtrl: '<' }, 
     controller: 'prmSearchResultAvailabilityLineAfterController',
     template: `
-          <div ng-if="article.data.browzineWebLink"><a href="{{ article.data.browzineWebLink }}" target="_blank"> See article in Table of Contents!</a></div>
-          <div ng-if="journal.data[0].browzineWebLink"><a href="{{ journal.data[0].browzineWebLink }}" target="_blank"> Browse this journal in Browzine!</a></div>  
-          ` 
+      <div ng-if="article.data.browzineWebLink"><a href="{{ article.data.browzineWebLink }}" target="_blank" title="Via Browzine"><img src="custom/01BRC_SOC/img/browzine.png" class="browzine-icon"> View Issue Contents <md-icon md-svg-icon="primo-ui:open-in-new" aria-label="icon-open-in-new" role="img" class="browzine-external-link"><svg id="open-in-new_cache29" width="100%" height="100%" viewBox="0 0 24 24" y="504" xmlns="http://www.w3.org/2000/svg" fit="" preserveAspectRatio="xMidYMid meet" focusable="false"></svg></md-icon></a></div>
+      <div ng-if="journal.data[0].browzineWebLink"><a href="{{ journal.data[0].browzineWebLink }}" target="_blank" title="Via Browzine"><img src="custom/01BRC_SOC/img/browzine.png" class="browzine-icon"> View Journal Contents <md-icon md-svg-icon="primo-ui:open-in-new" aria-label="icon-open-in-new" role="img" class="browzine-external-link"><svg id="open-in-new_cache29" width="100%" height="100%" viewBox="0 0 24 24" y="504" xmlns="http://www.w3.org/2000/svg" fit="" preserveAspectRatio="xMidYMid meet" focusable="false"></svg></md-icon></a></div>
+       ` 
   });
 
 // Add Journal Cover Images from Browzine