kilobtye · casperlamboo · Apr 20, 2016 · Apr 20, 2016 · Apr 20, 2016 · Feb 28, 2017
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,4 @@
+
+jspm_packages
+node_modules
+lib
diff --git a/README.md b/README.md
@@ -1,8 +1,110 @@
-potrace
-=======
+# POTRACE
+Based on http://potrace.sourceforge.net and https://github.com/kilobtye/potrace.
 
-A javascript port of [Potrace](http://potrace.sourceforge.net)
+Converts bitmap images to vector paths.
 
-[online demo](http://kilobtye.github.io/potrace/)
+# Usage
 
+### Using JSPM (ECMAScript / ES6 Module)
 
+Install the library.
+
+```
+jspm install POTRACE=github:casperlamboo/POTRACE
+```
+
+Include the library.
+
+```javascript
+import POTRACE from 'POTRACE';
+```
+
+### Using NPM (CommonJS module)
+
+Install the library.
+
+```
+npm install potrace-js
+```
+
+Include the library.
+
+```javascript
+var POTRACE = require('potrace-js');
+```
+
+# API
+
+**Options**
+
+```javascript
+{
+  turnpolicy: enum('black' | 'white' | 'left' | 'right' | 'minority' | 'majority'),
+  turdsize: Float,
+  optcurve: Bool,
+  alphamax: Float,
+  opttolerance: Float
+}
+```
+  - turnpolicy: how to resolve ambiguities in path decomposition. (default: "minority")       
+  - turdsize: suppress speckles of up to this size (default: 2)
+  - optcurve: turn on/off curve optimization (default: true)
+  - alphamax: corner threshold parameter (default: 1)
+  - opttolerance: curve optimization tolerance (default: 0.2)
+
+**POTRACE.traceUrl**
+
+Traces a given image from url.
+
+```javascript
+[...Path] = async POTRACE.traceUrl(url: String, [ options: Object ])
+```
+  - url: path to the image
+  - options: trace options
+
+**POTRACE.traceImage**
+
+Traces a given image.
+
+```javascript
+[...Path] = POTRACE.traceImage(image: HTMLImageElement, [ options: Object ])
+```
+  - image: image containing the image
+  - options: trace options
+
+**POTRACE.traceCanvas**
+
+Traces a given canvas.
+
+```javascript
+[...Path] = POTRACE.traceCanvas(canvas: HTMLCanvasElement, [ options: Object ])
+```
+  - canvas: canvas containing the image
+  - options: trace options
+
+**POTRACE.bitmap**
+
+Traces a given bitmap.
+
+  ```javascript
+  [...Path] = POTRACE.traceBitmap(bitmap: POTRACE.Bitmap, [ options: Object ])
+  ```
+    - bitmap: bitmap containing image info (1 and 0 values)
+    - options: trace options
+
+
+**POTRACE.getSVG**
+
+Converts trace result to svg.
+
+```javascript
+svg: String = POTRACE.getSVG([...Path])
+```
+
+**POTRACE.getPaths**
+
+Converts trace result to readable paths.
+
+```javascript
+svg: String = POTRACE.getPaths([...Path])
+```
diff --git a/example/index.html b/example/index.html
@@ -0,0 +1,22 @@
+<!DOCTYPE html>
+<html>
+  <head>
+
+    <meta charset="utf-8">
+
+    <title>Potrace</title>
+
+    <script type="text/javascript" src="/jspm_packages/system.src.js"></script>
+    <script type="text/javascript" src="/jspm.config.js"></script>
+
+  </head>
+  <body>
+
+    <div id="container"></div>
+
+    <script type="text/javascript">
+      System.import('./index.js');
+    </script>
+
+  </body>
+</html>
diff --git a/example/index.js b/example/index.js
@@ -0,0 +1,5 @@
+import * as POTRACE from 'src/index.js';
+
+POTRACE.traceUrl('test.png')
+  .then(paths => POTRACE.getSVG(paths, 1.0, 'curve'))
+  .then(svg => document.write(svg));
diff --git a/example/test.png b/example/test.png
diff --git a/jspm.config.js b/jspm.config.js
@@ -0,0 +1,34 @@
+SystemJS.config({
+  paths: {
+    "npm:": "jspm_packages/npm/",
+    "potrace/": "src/"
+  },
+  browserConfig: {
+    "baseURL": "/"
+  },
+  devConfig: {
+    "map": {
+      "plugin-babel": "npm:[email protected]"
+    }
+  },
+  transpiler: "plugin-babel",
+  packages: {
+    "potrace": {
+      "main": "potrace.js",
+      "meta": {
+        "*.js": {
+          "loader": "plugin-babel"
+        }
+      }
+    }
+  }
+});
+
+SystemJS.config({
+  packageConfigPaths: [
+    "npm:@*/*.json",
+    "npm:*.json"
+  ],
+  map: {},
+  packages: {}
+});
diff --git a/package.json b/package.json
@@ -0,0 +1,47 @@
+{
+  "name": "potrace-js",
+  "version": "0.0.5",
+  "description": "Traces bitmap images to vector paths",
+  "main": "lib/index.js",
+  "jspm": {
+    "name": "potrace",
+    "main": "index.js",
+    "directories": {
+      "lib": "src"
+    },
+    "devDependencies": {
+      "plugin-babel": "npm:systemjs-plugin-babel@^0.0.21"
+    }
+  },
+  "scripts": {
+    "prepublish": "npm run build",
+    "build": "babel src --out-dir lib",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "babel": {
+    "presets": [
+      "es2015"
+    ],
+    "plugins": [
+      "add-module-exports"
+    ]
+  },
+  "format": "esm",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/casperlamboo/potrace.git"
+  },
+  "author": "Casper Lamboo",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/casperlamboo/potrace/issues"
+  },
+  "homepage": "https://github.com/casperlamboo/potrace#readme",
+  "devDependencies": {
+    "babel-cli": "^6.23.0",
+    "babel-core": "^6.23.1",
+    "babel-plugin-add-module-exports": "^0.2.1",
+    "babel-preset-es2015": "^6.22.0",
+    "jspm": "^0.17.0-beta.40"
+  }
+}