From 87a9e889481ff798abd336ff583b446a4463ed6b Mon Sep 17 00:00:00 2001 From: Nick Playfair Date: Tue, 2 Feb 2021 21:03:11 +0000 Subject: [PATCH] Updated README --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 84b003c..5445d4d 100644 --- a/README.md +++ b/README.md @@ -10,24 +10,25 @@ Requires node version 10 or higher. ## Usage ``` -const fileProc = require('@nplayfair/npe_gerber'); +const { ImageGenerator } = require('@nplayfair/npe_gerber'); const folderConfig = { tmpDir: path.join(__dirname, 'tmp'), imgDir: path.join(__dirname, 'img') } -const config = { +const imageConfig = { + // Refer to the sharp documentation for these values resizeWidth: 600, density: 1000, compLevel: 1 } -fileProc.config(folderConfig); +const gerberArchive = '/path/to/gerber.zip'; -let gerberArchive = '/path/to/gerber.zip'; +const fileProc = new ImageGenerator(folderConfig, imageConfig); -fileProc.gerberToImage(gerberArchive, config, folderConfig.tmpDir, folderConfig.imgDir) +fileProc.gerberToImage(gerberArchive) .then(filename => { console.log(`Generated image ${filename}`); })