diff --git a/README.md b/README.md index 683a1a1..84b003c 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,33 @@ ![npm (scoped)](https://img.shields.io/npm/v/@nplayfair/npe_gerber) -Requires node version 10 or higher +**This is still being developed and isn't ready for production!** +Only tested with gerbers generated by EAGLE. -Image processing configuration example: +Requires node version 10 or higher. + +## Usage + +``` +const fileProc = require('@nplayfair/npe_gerber'); + +const folderConfig = { + tmpDir: path.join(__dirname, 'tmp'), + imgDir: path.join(__dirname, 'img') +} const config = { - resizeWidth: 600, - density: 1000, - compLevel: 1, -} \ No newline at end of file + resizeWidth: 600, + density: 1000, + compLevel: 1 +} + +fileProc.config(folderConfig); + +let gerberArchive = '/path/to/gerber.zip'; + +fileProc.gerberToImage(gerberArchive, config, folderConfig.tmpDir, folderConfig.imgDir) + .then(filename => { + console.log(`Generated image ${filename}`); + }) +``` \ No newline at end of file diff --git a/package.json b/package.json index 628bb87..97a40d2 100644 --- a/package.json +++ b/package.json @@ -16,6 +16,11 @@ "url": "https://github.com/nplayfair/npe_gerber/issues" }, "homepage": "https://github.com/nplayfair/npe_gerber#readme", + "keywords": [ + "pcb", + "image", + "gerber" + ], "dependencies": { "fs-extra": "^9.1.0", "jszip": "^3.5.0",