From 2b38c1256b952bcf3a8b81f3b81596e82d19a922 Mon Sep 17 00:00:00 2001 From: Nick Playfair <842413+nplayfair@users.noreply.github.com> Date: Fri, 13 Jun 2025 19:37:10 +0100 Subject: [PATCH] Update README --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9511a05..ddeb8eb 100644 --- a/README.md +++ b/README.md @@ -5,10 +5,12 @@ **This is still being developed and isn't ready for production!** Only tested with gerbers generated by EAGLE. -Requires node version 10 or higher. +node version 20 or higher recommended. ## Usage + ### Save a PNG file + ``` const { ImageGenerator } = require('@nplayfair/npe_gerber'); @@ -41,7 +43,9 @@ fileProc.gerberToImage(gerberArchive) console.log(`Generated image ${filename}`); }) ``` + ### Return a PNG stream + ``` const { ImageGenerator } = require('@nplayfair/npe_gerber'); @@ -74,6 +78,7 @@ fileProc.gerberToStream(gerberArchive) // Do something with the stream }) ``` + ## Layer Names The constructor must be passed an array of filenames that correspond to the layers in the gerber archives you expect to be uploaded. The example above shows which names are used by EAGLE but other applications may use different filenames.