@frameright/image-display-control-metadata-parser - npm Package Compare versions

Comparing version 1.1.0 to 1.1.1

dist/ImageRegion.d.ts

@@ -59,3 +59,3 @@ /**
      * `width`, `radius` and `vertices/x` when `unit` is `pixel`. See
-     * https://github.com/Frameright/image-display-control-web-component/blob/main/image-display-control/docs/reference/attributes.md
+     * https://docs.frameright.io/web-component/attribute-ref
      */
@@ -66,3 +66,3 @@ imageWidth?: number;
      * `height` and `vertices/y` when `unit` is `pixel`. See
-     * https://github.com/Frameright/image-display-control-web-component/blob/main/image-display-control/docs/reference/attributes.md
+     * https://docs.frameright.io/web-component/attribute-ref
      */
@@ -69,0 +69,0 @@ imageHeight?: number;

package.json

@@ -18,4 +18,5 @@ {
   ],
-  "version": "1.1.0",
+  "version": "1.1.1",
   "license": "MIT",
+  "repository": "https://github.com/Frameright/image-display-control-metadata-parser",
   "author": {
@@ -47,4 +48,3 @@ "name": "Frameright (Coberg Ltd)",
     "gendoc": "typedoc",
-    "gentoc": "./bin/gentoc.sh",
-    "spellcheck": "npx mdspell '**/*.md' '!**/node_modules/**' '!**/generated*/**' --ignore-acronyms --ignore-numbers --no-suggestions --en-us"
+    "gentoc": "./bin/gentoc.sh"
   },
@@ -64,3 +64,2 @@ "prettier": {
     "husky": "^8.0.3",
-    "markdown-spellcheck": "^1.3.1",
     "markdown-toc": "^1.2.0",
@@ -67,0 +66,0 @@ "prettier": "^2.8.7",

README.md

@@ -7,5 +7,12 @@ [<img src="https://avatars.githubusercontent.com/u/35964478?s=200&v=4" align="right" width="64" height="64">](https://frameright.io)
 
-<!-- Note: make sure all URLs in this document are absolute, and not relative
-     within GitHub, as we are publishing this file to NPM and want URLs to
-     remain valid there. -->
+<!--
+WARNINGS:
+* Bits of information here are duplicated in several places:
+    * https://docs.frameright.io/javascript
+    * https://github.com/Frameright/image-display-control-metadata-parser
+  Make sure to keep them in sync.
+* Make sure all URLs in this document are absolute, and not relative within
+  GitHub, as we are publishing this file to NPM and want URLs to remain valid
+  there.
+-->
 
@@ -18,2 +25,4 @@ # Image Display Control metadata parsing library
 
+&emsp; :bulb: [GitHub Discussions](https://github.com/Frameright/image-display-control-web-component/discussions)
+
 > **NOTE**: this is a wrapper around
@@ -34,3 +43,2 @@ > [mattiasw/ExifReader](https://github.com/mattiasw/ExifReader) and
 - [Image Display Control metadata](#image-display-control-metadata)
-- [Changelog](#changelog)
 
@@ -84,4 +92,8 @@ <!-- tocstop -->
 
-> **NOTE**: a PHP equivalent of this library is available
-> [here](https://github.com/Frameright/php-image-metadata-parser).
+> **NOTES**:
+>
+> * A React component leveraging this library is available
+>   [here](https://github.com/Frameright/react-image-display-control).
+> * A PHP equivalent of this library is available
+>   [here](https://github.com/Frameright/php-image-metadata-parser).
 
@@ -112,6 +124,12 @@ ## Usage
 
+&emsp; :memo: [Tutorial](https://www.frameright.io/post/metadata-in-node-js)
+
 &emsp; :scroll: [Reference](https://github.com/Frameright/image-display-control-metadata-parser/blob/main/generated-docs/classes/Parser.md)
 
-&emsp; :wrench: [Contributing](https://github.com/Frameright/image-display-control-metadata-parser/blob/main/docs/contributing.md)
+&emsp; :wrench: [Contributing](https://docs.frameright.io/javascript/contributing)
 
+&emsp; 📝 [Changelog](https://docs.frameright.io/javascript/contributing)
+
+&emsp; :bulb: [GitHub Discussions](https://github.com/Frameright/image-display-control-web-component/discussions)
+
 ### Directly in a browser
@@ -126,3 +144,3 @@
       type="module"
-      src="https://cdn.jsdelivr.net/npm/@frameright/image-display-control-metadata-parser@1.1.0/dist/image-display-control-metadata-parser-standalone.min.js"
+      src="https://cdn.jsdelivr.net/npm/@frameright/image-display-control-metadata-parser@1.1.1/dist/image-display-control-metadata-parser-standalone.min.js"
     ></script>
@@ -149,2 +167,5 @@
 
+[This React component](https://github.com/Frameright/react-image-display-control/blob/main/src/index.tsx)
+is an example of doing that.
+
 &emsp; :sparkles: [Live mobile demo](https://webc.frameright.io)
@@ -160,27 +181,1 @@
 the metadata of their pictures.
-
-## Changelog
-
-**1.1.0** (2023-05-18):
-  * Added one more export path inside `package.json` in order to support
-    dynamic `import()`.
-
-**1.0.4** (2023-05-12):
-  * Fixed parsing bug for image regions having only one role.
-
-**1.0.3** (2023-04-22):
-  * Document how to use the browser build.
-
-**1.0.2** (2023-04-21):
-  * Add missing `Buffer` class to the browser build.
-
-**1.0.1** (2023-04-21):
-  * Remove dangling imports to Node.js built-in modules (e.g. `fs`) from the
-    browser build.
-
-**1.0.0** (2023-04-21):
-  * Build `image-display-control-metadata-parser-standalone.min.js` to be served
-    by a CDN and used in the browser.
-
-**0.1.0** (2023-04-19):
-  * Initial version.

src/ImageRegion.ts

@@ -75,3 +75,3 @@ /**
    * `width`, `radius` and `vertices/x` when `unit` is `pixel`. See
-   * https://github.com/Frameright/image-display-control-web-component/blob/main/image-display-control/docs/reference/attributes.md
+   * https://docs.frameright.io/web-component/attribute-ref
    */
@@ -83,3 +83,3 @@ public imageWidth?: number;
    * `height` and `vertices/y` when `unit` is `pixel`. See
-   * https://github.com/Frameright/image-display-control-web-component/blob/main/image-display-control/docs/reference/attributes.md
+   * https://docs.frameright.io/web-component/attribute-ref
    */
@@ -86,0 +86,0 @@ public imageHeight?: number;

Fixed alerts

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

Improved metrics

Dev dependency count

15

decreased by-6.25%

Worsened metrics

Total package byte prevSize

230305

decreased by-0.3%

Number of lines in readme file

174

decreased by-2.79%

No dependency changes