Mark 'canvas' as optional dependency, update Node demo with dynamic i…

…mport
stefcameron · Mar 12, 2024 · c59070d · c59070d
1 parent ca21825
commit c59070d
Show file tree

Hide file tree

Showing 5 changed files with 96 additions and 79 deletions.
diff --git a/.gitignore b/.gitignore
@@ -16,6 +16,8 @@
 
 # Packages (deep)
 node_modules/
+yarn.lock
+pnpm-lock.yaml
 
 # Generated builds (deep)
 dist/

diff --git a/README.md b/README.md
@@ -47,7 +47,7 @@ $ yarn add text-to-canvas
 
 ## Compilation of canvas package
 
-This project depends on the [canvas](https://github.com/Automattic/node-canvas) package which enables its use in Node.
+This project __optionally__ depends on the [canvas](https://github.com/Automattic/node-canvas) package which enables it to be used in a Node [demo](#node).
 
 Since this package needs to be compiled for use on the platform on which you intend to install/use it, the author must either include pre-built binaries specific to your OS when they make a [release](https://github.com/Automattic/node-canvas/releases), or a new binary must be compiled by your package manager (i.e. `npm`) upon installation.