@cogapp/storiiies-viewer - npm Package Compare versions

Comparing version 1.0.5 to 2.0.0

package.json

 {
   "name": "@cogapp/storiiies-viewer",
-  "version": "1.0.5",
+  "version": "2.0.0",
   "description": "A viewer for Storiiies",
@@ -5,0 +5,0 @@ "exports": {

README.md

@@ -8,2 +8,3 @@ # Storiiies Viewer ![Build status badge](https://github.com/CogappLabs/StoriiiesViewer/actions/workflows/build.yml/badge.svg)
 ## Demo
+
 [See an example StoriiiesViewer in action on codepen](https://codepen.io/Cogapp/pen/JjxbjGz)
@@ -38,3 +39,2 @@
 
-
 #### Using a bundler
@@ -46,5 +46,6 @@
 
+### Initialise a viewer
 
-### Initialise a viewer
 In your HTML:
+
 ```HTML
@@ -55,2 +56,3 @@ <div id="storiiies-viewer"></div>
 In your JavaScript
+
 ```JS
@@ -73,9 +75,10 @@ document.addEventListener('DOMContentLoaded', () => {
 
+## Supported manifest formats
 
-
-## Supported manifest formats
 StoriiiesViewer supports a subset of the [IIIF presentation API v3](https://iiif.io/api/presentation/3.0/). Specifically, we target `annotationPages` which are included directly in the manifest ([like in this cookbook recipe](https://iiif.io/api/cookbook/recipe/0258-tagging-external-resource/)).
 
-Annotations themselves can either be `text/plain` or `text/html` denoted by the `format` field. For `text/plain` newline characters will be converted and output as `<br>` tags.
+Text based annotations can either be `text/plain` or `text/html` denoted by the `format` field. For `text/plain` newline characters will be converted and output as `<br>` tags.
 
+Support for audio exists, and StoriiiesViewer will render an `<audio />` element for annotations that have a type of `Sound`, and which are structured [like shown this cookbook recipe](https://iiif.io/api/cookbook/recipe/0002-mvm-audio/).
+
 StoriiiesViewer has no required fields (aside from those required by the presentation API), but it will render certain values from the manifest if provided. These are:
@@ -92,3 +95,2 @@
 > - Multiple images
-> - Non-text based annotations (e.g. audio)
 > - Full multi-lingual support
@@ -105,3 +107,3 @@ >
 
-For example, for the link https://storiiies.cogapp.com/viewer/7e4va/A-Sunday-on-La-Grande-Jatte-1884 use a manifest URL of https://manifest.storiiies-editor.cogapp.com/v3/7e4va
+For example, for the link <https://storiiies.cogapp.com/viewer/7e4va/A-Sunday-on-La-Grande-Jatte-1884> use a manifest URL of <https://manifest.storiiies-editor.cogapp.com/v3/7e4va>
 
@@ -151,3 +153,2 @@ ## Local development
 
-
 ### Running the tests
@@ -154,0 +155,0 @@

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1006012

increased by0.1%

Lines of code

15802

increased by0.1%

Number of lines in readme file

192

increased by0.52%

Number of medium supply chain risk alerts

2

decreased by-33.33%

No dependency changes