Skip to content
This repository has been archived by the owner on Jul 23, 2018. It is now read-only.

Commit

Permalink
update readme for 0.0.6
Browse files Browse the repository at this point in the history
  • Loading branch information
mcous committed Aug 11, 2014
1 parent 27cbe49 commit 9c66d93
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 3 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<script src="path/to/gerber-to-svg.js"></script>` 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).
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down

0 comments on commit 9c66d93

Please sign in to comment.