Merge pull request #54 from bodleian/qa

Release 2023-05-02

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Bodleian Libraries
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,23 +1,56 @@
 # archiox-mirador-plugin
-This is a dev version of the archiox-mirador-plugin, it will not work as a mirador plugin yet, it is designed to run
-as a standalone mirador instance for development.  If you wish to get this working you will need either access to the
-Bodleian VPN or you will have to have your own image tile and image server running.  This example runs using
-a public gist hosted on Richard Benjamin Allen's GitHub.
+This is a dev version of the archiox-mirador-plugin, it is designed to be installed as a mirador plug-in.
 
 # Installation
 Make sure you have node.js and npm installed.  It might also be good to install nvm to allow you to switch versions of
 node.js more easily.
 
-To install run the following command from the root directory of the repository.
+To add and install  the plugin into you Mirador instance run the following commands from the root directory of your 
+Mirador build repository (you will need to be able to access using an ssh key).
+
+First add the plugin to your dependencies.
 
 ```bash
-npm install
+npm install git+ssh://[email protected]:bodleian/archiox-mirador-plugin.git
 ```
 
-Then to run the dev server.
+Then install all your dependencies including the plugin.
 
 ```bash
-npm start
+npm install
+```
+
+Make sure you have the following npm packages installed in your mirador instance:
+
+* @babel/core 
+* @babel/preset-env
+* @babel/preset-react    
+* babel-loader
+
+Make sure you have a `babel.config.js` file containing the following:
+
+```ecmascript 6
+module.exports = {
+    presets:[
+        "@babel/preset-env",
+        "@babel/preset-react"
+    ]
+}
+```
+
+Make sure you add the following to your `webpack.config.js` file to enable experimental jsx usage in react files:
+
+```ecmascript 6
+module: {
+    rules: [
+      {
+        test: /\.(js|jsx)$/,
+        loader: 'babel-loader',
+        options: { presets: ['@babel/env','@babel/preset-react'] },
+      }
+    ]
+  }
 ```
+
 # Development
 All new features should be placed in feature branches and not pushed direct to `Qa` or `Master` as per our other repos.  That way we can test new features without breaking anything.