Additional documentation work

.gitignore

@@ -1,2 +1,3 @@
 *.ast
 node_modules
+doc/jsts.js

README.md

@@ -2,28 +2,24 @@
 
 [![Build Status](https://travis-ci.org/bjornharrtell/jsts.svg)](https://travis-ci.org/bjornharrtell/jsts)
 
-JSTS is a JavaScript (ES6 aka. ECMAScript 2015) library of spatial predicates and functions for processing geometry conforming to the Simple Features Specification for SQL published by the Open Geospatial Consortium. JSTS is also a JavaScript port of the well established Java library [JTS](https://github.com/locationtech/jts).
+JSTS is an ECMAScript 2015 library of spatial predicates and functions for processing geometry conforming to the Simple Features Specification for SQL published by the Open Geospatial Consortium. JSTS is also a port of the well established Java library [JTS](https://github.com/dr-jts/jts).
 
 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.0-rc1/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.0.0-rc2/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.0-rc1/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.0.0-rc2/validationsuite/index.html) of [JTS Validation Suite](http://www.vividsolutions.com/jts/tests/index.html) provides additional tests.
 
-Basic functionality togheter with OpenLayers 3 is demonstrated [here](http://bjornharrtell.github.io/jsts).
+Basic functionality together with OpenLayers 3 is demonstrated [here](http://bjornharrtell.github.io/jsts).
 
-## Usage
+## Browser or Node.js use
 
-### Browser
+An ES5 (the most common JavaScript variant) compatible build for browsers is available [here](https://cdn.rawgit.com/bjornharrtell/jsts/gh-pages/1.0.0-rc2/jsts.min.js).
 
-An ES5 compatible build for browser use is available [here](https://cdn.rawgit.com/bjornharrtell/jsts/gh-pages/1.0.0-rc1/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.0-rc2/apidocs/).
 
-Including the above build as a script will import a global object `jsts` exposing the same public API as `org.locationtech.jts` in the JTS API.
+For Node.js, install using `npm install [email protected]` after which `require('jsts')` will import an object with the same properties as `jsts` in the browser build.
 
-### Node JS
-
-Install using `npm install [email protected]` 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 [specific API documentation](http://bjornharrtell.github.io/jsts/1.0.0-rc2/doc/) for these specific classes.

doc/node.json → doc/es5.json

@@ -12,7 +12,7 @@
         "exclude": [
         ],
         "include": [
-          "doc/jsts.js", "doc/node.md"
+          "doc/jsts.js", "doc/es5.md"
         ]
     },
     "plugins": [

doc/es5.md

@@ -0,0 +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.0-rc1/apidocs/).

doc/browser.json → doc/es6.json

@@ -1,6 +1,6 @@
 {
     "opts": {
-        "recurse": false,
+        "recurse": true,
         "destination": "dist/doc"
     },
     "tags": {
@@ -12,7 +12,7 @@
         "exclude": [
         ],
         "include": [
-          "doc/jsts.js", "doc/browser.md"
+          "src", "doc/es6.md"
         ]
     },
     "plugins": [
@@ -24,8 +24,8 @@
         "copyright": "Björn Harrtell",
         "monospaceLinks": true,
         "default": {
-            "outputSourceFiles": false,
-            "useLongnameInNav": false
+            "outputSourceFiles": true,
+            "useLongnameInNav": true
         },
         "applicationName": "JSTS"
     }

doc/es6.md

@@ -0,0 +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/).