Skip to content

Commit

Permalink
Bump versions and cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
bjornharrtell committed Apr 8, 2016
1 parent 4fe930b commit 245a98c
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 9 deletions.
10 changes: 5 additions & 5 deletions README.md
Expand Up @@ -6,23 +6,23 @@ JSTS is an ECMAScript 2015 library of spatial predicates and functions for proce

The primary goal of the project is to provide web mapping applications with a complete library for processing and analyzing simple geometries but JSTS can also be used as a free standing geometry library.

JSTS was made using automatic translation of the original JTS Java source via AST to AST transformation preserving the [JTS API](http://bjornharrtell.github.io/jsts/1.0.2/apidocs/), except for the io related classes which has been selectively and manually ported with support for WKT, GeoJSON and OpenLayers 3.
JSTS was made using automatic translation of the original JTS Java source via AST to AST transformation preserving the [JTS API](http://bjornharrtell.github.io/jsts/1.1.0/apidocs/), except for the io related classes which has been selectively and manually ported with support for WKT, GeoJSON and OpenLayers 3.

A [Google group](http://groups.google.com/group/jsts-devs) is available for discussions.

A [port](http://bjornharrtell.github.com/jsts/1.0.2/validationsuite/index.html) of [JTS Validation Suite](http://www.vividsolutions.com/jts/tests/index.html) provides additional tests.
A [port](http://bjornharrtell.github.com/jsts/1.1.0/validationsuite/index.html) of [JTS Validation Suite](http://www.vividsolutions.com/jts/tests/index.html) provides additional tests.

Basic functionality together with OpenLayers 3 is demonstrated [here](http://bjornharrtell.github.io/jsts).

## Browser or Node.js use

An ES5 (the most common JavaScript variant) compatible build for browsers is available [here](https://cdn.rawgit.com/bjornharrtell/jsts/gh-pages/1.0.2/jsts.min.js).
An ES5 (the most common JavaScript variant) compatible build for browsers is available [here](https://cdn.rawgit.com/bjornharrtell/jsts/gh-pages/1.1.0/jsts.min.js).

Including the above build as a script will import a global object `jsts` exposing similar public API as `org.locationtech.jts` in the [JTS API](http://bjornharrtell.github.io/jsts/1.0.2/apidocs/).
Including the above build as a script will import a global object `jsts` exposing similar public API as `org.locationtech.jts` in the [JTS API](http://bjornharrtell.github.io/jsts/1.1.0/apidocs/).

For Node.js, install using `npm install jsts` after which `require('jsts')` will import an object with the same properties as `jsts` in the browser build.

I/O related classes in JTS had to be manually ported. From the original formats WKT and GeoJSON are supported. A direct reader/writer for OpenLayers 3 geometries exist. See the [API documentation](http://bjornharrtell.github.io/jsts/1.0.2/doc/) for these specific classes.
I/O related classes in JTS had to be manually ported. From the original formats WKT and GeoJSON are supported. A direct reader/writer for OpenLayers 3 geometries exist. See the [API documentation](http://bjornharrtell.github.io/jsts/1.1.0/doc/) for these specific classes.

## Caveats

Expand Down
2 changes: 1 addition & 1 deletion doc/es5.md
@@ -1 +1 @@
This API documentation is for the ES5 builds for browser or Node Js use and describe the manually ported IO-classes. Note that the `jsts` module, via translated source, also exposes the same public API as `org.locationtech.jts` in the [JTS API](http://bjornharrtell.github.io/jsts/1.0.2/apidocs/) that is not shown here.
This API documentation is for the ES5 builds for browser or Node Js use and describe the manually ported IO-classes. Note that the `jsts` module, via translated source, also exposes the same public API as `org.locationtech.jts` in the [JTS API](http://bjornharrtell.github.io/jsts/1.1.0/apidocs/) that is not shown here.
2 changes: 1 addition & 1 deletion doc/es6.md
@@ -1 +1 @@
This API documentation is for the ES6 source and describe the manually ported IO-classes. Note that the `jsts` module via translated source also exposes the same public API as `org.locationtech.jts` in the [JTS API](http://bjornharrtell.github.io/jsts/1.0.0-rc1/apidocs/).
This API documentation is for the ES6 source and describe the manually ported IO-classes. Note that the `jsts` module via translated source also exposes the same public API as `org.locationtech.jts` in the [JTS API](http://bjornharrtell.github.io/jsts/1.1.0/apidocs/).
3 changes: 1 addition & 2 deletions package.json
Expand Up @@ -11,7 +11,7 @@
"Topology",
"Geometry"
],
"license": "(BSD-3-Clause OR EPL-1.0)",
"license": "(EDL-1.0 OR EPL-1.0)",
"devDependencies": {
"babel-core": "6.7.4",
"babel-preset-es2015": "6.6.0",
Expand Down Expand Up @@ -47,7 +47,6 @@
"test": "NODE_PATH=src mocha --compilers js:babel-register --recursive test/auto/node test/manual",
"build-jsdoc-es5": "rollup -c rollup.config.js > doc/jsts.js && jsdoc -c doc/es5.json",
"build": "rollup -c rollup.config.js | uglifyjs -c -m --screw-ie8 | (cat license.txt && cat) > dist/jsts.min.js",
"build2": "rollup -c rollup.config.js | (cat license.txt && cat) > dist/jsts.js",
"build-es6": "rollup -c rollup.config.es6.js | (cat license.txt && cat) > dist/jsts.es6.js",
"build-tests": "NODE_PATH=src browserify test/auto/browser/runner.js -o dist/tests.js -t [ babelify --presets [ es2015 ] ]"
}
Expand Down

0 comments on commit 245a98c

Please sign in to comment.