From 9c66d937d3e1764251653fef3c2d9abcdba37f94 Mon Sep 17 00:00:00 2001 From: Mike Cousins Date: Mon, 11 Aug 2014 08:52:08 -0400 Subject: [PATCH] update readme for 0.0.6 --- README.md | 9 +++++++-- package.json | 2 +- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 69c73e0..807dbec 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,17 @@ Gerber file to SVG converter for Node and the browser. 2. `$ gerber2svg /path/to/gerber` (writes to stdout) * `$ gerber2svg /path/to/gerber > file.svg` will write to a file -### api (with Node or in the Browser with Browserify) +### api (node and browser) +For Node and Browserify: 1. `$ npm install --save(-dev) gerber-to-svg` +2. Add `var gerberToSvg = require(gerber-to-svg);` to your JavaScript + +If you'd rather not manage your packages: +1. Download the standalone [library]() or [minified library]() +2. Add `` to your HTML before your application Use in your app with: ``` javascript -var gerberToSvg = require(gerber-to-svg); var svgString = gerberToSvg(gerberString); ``` Where `gerberString` is the gerber file (e.g. from fs.readFile encoded with UTF-8 or FileReader.readAsText). diff --git a/package.json b/package.json index 7ff5379..9279ce8 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "gerber-to-svg", - "version": "0.0.5", + "version": "0.0.6", "description": "Gerber file to SVG converter", "main": "lib/gerber-to-svg.js", "bin": {