From 3e43b23893294981e8c39d1050f2e96d47a9df01 Mon Sep 17 00:00:00 2001 From: Chris Hutchinson <1573022+chrishutchinson@users.noreply.github.com> Date: Sun, 20 Jun 2021 16:46:48 +0100 Subject: [PATCH] fix: update the Node.js version in package.json>engines (#98) --- README.md | 2 +- docs/code/Card.html | 2 +- docs/code/CardKit.html | 2 +- docs/code/CardKitDOM.html | 2 +- docs/code/CardKitServer.html | 2 +- docs/code/SVGToImage.html | 2 +- docs/code/cardkit.js.html | 2 +- docs/code/index.html | 10 +- docs/code/renderers_dom_SVGToImage.js.html | 2 +- docs/code/renderers_dom_dom.js.html | 2 +- docs/code/renderers_server_server.js.html | 2 +- docs/code/renderers_shared_Card.js.html | 2 +- package.json | 11 +- yarn.lock | 7933 ++++++++++++++++++++ 14 files changed, 7954 insertions(+), 22 deletions(-) create mode 100644 yarn.lock diff --git a/README.md b/README.md index a8f992c..c115ff9 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ Additionally, a base class allows you to create your own renderers. See more in CardKit requires a configuration object in order to render an image. Each renderer (CardKitDOM and CardKitServer) uses this configuration and converts it into an output. Below are simple implementations for CardKit depending on your use case. -In addition to these, you may also want to try the [CardKit Yeoman Generator](https://www.github.com/times/generator-cardkit), which can help you scaffold an entire project in just a few moments. It brings with it the latest version of CardKit, a recommended directory structure, and a build process that helps you get your CardKit project deployed. There is also a [JSFiddle](https://jsfiddle.net/chrishutchinson/16tLs2ta/) that you can fork and edit for quick in-browser testing without touching the command line. +In addition to these, you may also want to try the [CardKit Yeoman Generator](https://www.github.com/times/generator-cardkit), which can help you scaffold an entire project in just a few moments. It brings with it the latest version of CardKit, a recommended directory structure, and a build process that helps you get your CardKit project deployed. There is also a [JSFiddle](https://jsfiddle.net/chrishutchinson/16tLs2ta/) that you can fork and edit for quick in-browser testing without touching the command line. ### Previous versions diff --git a/docs/code/Card.html b/docs/code/Card.html index 111498a..e52c531 100644 --- a/docs/code/Card.html +++ b/docs/code/Card.html @@ -1155,7 +1155,7 @@
Returns:

diff --git a/docs/code/CardKit.html b/docs/code/CardKit.html index f845251..b950431 100644 --- a/docs/code/CardKit.html +++ b/docs/code/CardKit.html @@ -3487,7 +3487,7 @@
Parameters:

diff --git a/docs/code/CardKitDOM.html b/docs/code/CardKitDOM.html index 885bd0f..f7e8d5d 100644 --- a/docs/code/CardKitDOM.html +++ b/docs/code/CardKitDOM.html @@ -1775,7 +1775,7 @@

rerender
- Generated by JSDoc 3.6.6 on Mon May 03 2021 18:01:46 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Sun Jun 20 2021 16:41:21 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/code/CardKitServer.html b/docs/code/CardKitServer.html index 445a126..75d0d28 100644 --- a/docs/code/CardKitServer.html +++ b/docs/code/CardKitServer.html @@ -853,7 +853,7 @@
Returns:

- Generated by JSDoc 3.6.6 on Mon May 03 2021 18:01:46 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Sun Jun 20 2021 16:41:21 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/code/SVGToImage.html b/docs/code/SVGToImage.html index f3f5d98..edec267 100644 --- a/docs/code/SVGToImage.html +++ b/docs/code/SVGToImage.html @@ -1907,7 +1907,7 @@
Parameters:

- Generated by JSDoc 3.6.6 on Mon May 03 2021 18:01:46 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Sun Jun 20 2021 16:41:21 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/code/cardkit.js.html b/docs/code/cardkit.js.html index c56def5..f2946ea 100644 --- a/docs/code/cardkit.js.html +++ b/docs/code/cardkit.js.html @@ -284,7 +284,7 @@

cardkit.js


- Generated by JSDoc 3.6.6 on Mon May 03 2021 18:01:46 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Sun Jun 20 2021 16:41:21 GMT+0100 (British Summer Time) using the Minami theme.
diff --git a/docs/code/index.html b/docs/code/index.html index b5a4b52..69a5170 100644 --- a/docs/code/index.html +++ b/docs/code/index.html @@ -59,12 +59,14 @@
  • CardKitServer: A server renderer, that allows you to take an instance of CardKit and render it into an image on a Node.js server

    • Additionally, a base class allows you to create your own renderers. See more in the Custom Renderers section.

    -

    For version 1, see the v1-master branch

    Installation

    $ npm install cardkit --save

    Usage

    CardKit requires a configuration object in order to render an image. Each renderer (CardKitDOM and CardKitServer) uses this configuration and converts it into an output. Below are simple implementations for CardKit depending on your use case.

    In addition to these, you may also want to try the CardKit Yeoman Generator, which can help you scaffold an entire project in just a few moments. It brings with it the latest version of CardKit, a recommended directory structure, and a build process that helps you get your CardKit project deployed. There is also a JSFiddle that you can fork and edit for quick in-browser testing without touching the command line.

    +

    Previous versions

    +

    For version 1, see the v1-main branch.

    +

    For version 2, see the v2-main branch.

    Yeoman generator

    $ npm install -g yo generator-cardkit
 $ yo cardkit
@@ -280,10 +282,8 @@ 
    Custom Fonts
    
   // ...
 };
    -

    Upgrading from v1.x

    -

    Upgrading from v1.x to v2 should be a fairly straightforward process if you haven't made any major modifications to the v1.x user interface. Your configuration object from v1.x should be compatible with v2 with a few minor tweaks. Specific variations are available in the Wiki.

    Running locally

    -

    CardKit currently requires Node.js 8, which you can install using nvm and running:

    +

    CardKit currently requires Node.js 14, which you can install using nvm and running:

    $ nvm use

    To run a sample UI locally, run: $ npm start

    @@ -302,7 +302,7 @@

    Tests


    - Generated by JSDoc 3.6.6 on Mon May 03 2021 18:01:46 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Sun Jun 20 2021 16:41:21 GMT+0100 (British Summer Time) using the Minami theme.
    diff --git a/docs/code/renderers_dom_SVGToImage.js.html b/docs/code/renderers_dom_SVGToImage.js.html index 17e2486..d3bc235 100644 --- a/docs/code/renderers_dom_SVGToImage.js.html +++ b/docs/code/renderers_dom_SVGToImage.js.html @@ -320,7 +320,7 @@

    renderers/dom/SVGToImage.js


    - Generated by JSDoc 3.6.6 on Mon May 03 2021 18:01:46 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Sun Jun 20 2021 16:41:21 GMT+0100 (British Summer Time) using the Minami theme.
    diff --git a/docs/code/renderers_dom_dom.js.html b/docs/code/renderers_dom_dom.js.html index 7e4eb7d..5c625ff 100644 --- a/docs/code/renderers_dom_dom.js.html +++ b/docs/code/renderers_dom_dom.js.html @@ -224,7 +224,7 @@

    renderers/dom/dom.js


    - Generated by JSDoc 3.6.6 on Mon May 03 2021 18:01:46 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Sun Jun 20 2021 16:41:21 GMT+0100 (British Summer Time) using the Minami theme.
    diff --git a/docs/code/renderers_server_server.js.html b/docs/code/renderers_server_server.js.html index 94ab34a..fc82fbc 100644 --- a/docs/code/renderers_server_server.js.html +++ b/docs/code/renderers_server_server.js.html @@ -118,7 +118,7 @@

    renderers/server/server.js


    - Generated by JSDoc 3.6.6 on Mon May 03 2021 18:01:46 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Sun Jun 20 2021 16:41:21 GMT+0100 (British Summer Time) using the Minami theme.
    diff --git a/docs/code/renderers_shared_Card.js.html b/docs/code/renderers_shared_Card.js.html index 9caf3fe..889c347 100644 --- a/docs/code/renderers_shared_Card.js.html +++ b/docs/code/renderers_shared_Card.js.html @@ -409,7 +409,7 @@

    renderers/shared/Card.js


    - Generated by JSDoc 3.6.6 on Mon May 03 2021 18:01:46 GMT+0100 (British Summer Time) using the Minami theme. + Generated by JSDoc 3.6.7 on Sun Jun 20 2021 16:41:21 GMT+0100 (British Summer Time) using the Minami theme.
    diff --git a/package.json b/package.json index 91a7d52..e1329bc 100644 --- a/package.json +++ b/package.json @@ -12,22 +12,21 @@ "url": "https://github.com/chrishutchinson/cardkit.git" }, "engines": { - "node": ">14" + "node": ">=14" }, "scripts": { "test": "istanbul cover --dir test/coverage _mocha -- --require @babel/register --require ignore-styles", - "jsdoc": "jsdoc -c ./jsdoc.config.json -d ./docs/code -t ./node_modules/minami --verbose -R ./README.md", "demo": "webpack --env=dist-docs", - "docs": "npm run jsdoc", + "docs": "jsdoc -c ./jsdoc.config.json -d ./docs/code -t ./node_modules/minami --verbose -R ./README.md", "start": "webpack-dev-server -d --content-base ./src --hot --open", - "dist": "npm run build", - "build": "echo \"[NOTICE] This task will build ALL CardKit versions\"; echo \"[LOG] Building DOM library\"; npm run build-dom; echo \"[LOG] Building server library\"; npm run build-server; echo \"[LOG] Building core library\"; npm run build-core; echo \"[LOG] Building DOM