Skip to content

Commit

Permalink
Tag v 0.9.10 fixes typos in README
Browse files Browse the repository at this point in the history
  • Loading branch information
ffflabs committed Aug 30, 2018
1 parent 2ea152e commit c4c5c5a
Show file tree
Hide file tree
Showing 7 changed files with 20 additions and 20 deletions.
26 changes: 13 additions & 13 deletions README.md
Expand Up @@ -6,7 +6,7 @@ A bridge to use [Turf](http://turfjs.org) along with [google Maps API](https://d

## Motivation

Turf offers a rich set of geometric operations, but it works with GeoJSON inputs. This library bridges a subset of turf operations (thay might steadily grow)
Turf offers a rich set of geometric operations, but it works with GeoJSON inputs. This library bridges a subset of turf operations (that might steadily grow)
to allow the user to apply the same operations to google maps objects such as Polygons, Polylines and Markers.

Most of these methods return a GeoJSON feature, given the output of these geometric operations might not be suitable for conversion to a google maps object (which is the case of MultiPolygons or MultiLinestring). Some of them accept an `output` parameter that, if passed `object` as value, will try to return
Expand Down Expand Up @@ -53,64 +53,64 @@ Which might help you perform some tree shaking in your build stage.

Takes a google.maps.Polyline and returns a Feature of type Point at a specified distance along the line.

See [along](docs/src/components/along.md).
See [along](docs/along.md).

### buffer

Takes a google.maps.Polyline or google.maps.Polygon and returna a Feature of type Polygon or MultiPolygon surrounding the former at a specified distance
Takes a google.maps.Polyline or google.maps.Polygon and returns a Feature of type Polygon or MultiPolygon surrounding the former at a specified distance

See [buffer](docs/src/components/buffer.md).
See [buffer](docs/buffer.md).

### concave

Takes a set of gooogle.maps.LatLng or google.maps.LatLngLiteral and returns a concave hull Feature of type Polygon or MultiPolygon

See [concave](docs/src/components/concave.md).
See [concave](docs/concave.md).

### coords_to_latlng

Different helper methods to transform gooogle.maps.LatLng or google.maps.LatLngLiteral to GeoJSON positions or viceversa

See [coords_to_latlng](docs/src/components/coords_to_latlng.md).
See [coords_to_latlng](docs/coords_to_latlng.md).

### kinks

Takes a google.maps.Polygon and returns a FeatureCollection of Points representing the polygon self intersections

See [kinks](docs/src/components/kinks.md).
See [kinks](docs/kinks.md).

### point_in_polygon

Takes an array of google.maps.Marker and a Polygon or MultiPolygon, returning an object containing with markers fall inside or outside it

See [point_in_polygon](docs/src/components/point_in_polygon.md).
See [point_in_polygon](docs/point_in_polygon.md).

### simplify_things

Takes a google.maps.Polygon or google.maps.Polyline and returns a simplified version given a certain tolerance. Uses Douglas-Peucker algorithm

See [simplify_things](docs/src/components/simplify_things.md).
See [simplify_things](docs/simplify_things.md).

### trimpaths

Takes two google.maps.Polyline and returns an array of coordinates [path of trimmed polyline1, path of trimmed polyline2, intersection point]

See [trimpaths](docs/src/components/trimpaths.md).
See [trimpaths](docs/trimpaths.md).

### union

Takes two or more google.maps.Polygon and returns a Feature of type Polygon or MultiPolygon with their union

See [union](docs/src/components/union.md).
See [union](docs/union.md).

### unkink

Takes a google.maps.Polygon with self intersections and returns a FeatureCollection of polygons without self intersections

See [unkink](docs/src/components/unkink.md).
See [unkink](docs/unkink.md).

### utils

Several utility functions to transform back and forth google.maps objects and Feature of their corresponding type

See [utils](docs/src/components/utils.md).
See [utils](docs/utils.md).
2 changes: 1 addition & 1 deletion dist/ig_subset.js
@@ -1,7 +1,7 @@

/*
* turf-google-maps
* version v0.9.9
* version v0.9.10
* MIT Licensed
* Felipe Figueroa (amenadiel@gmail.com)
* https://github.com/HuasoFoundries/turf-google-maps
Expand Down
2 changes: 1 addition & 1 deletion dist/ig_turfhelper.esm.js
@@ -1,7 +1,7 @@

/*
* turf-google-maps
* version v0.9.9
* version v0.9.10
* MIT Licensed
* Felipe Figueroa (amenadiel@gmail.com)
* https://github.com/HuasoFoundries/turf-google-maps
Expand Down
2 changes: 1 addition & 1 deletion dist/ig_turfhelper.js
@@ -1,7 +1,7 @@

/*
* turf-google-maps
* version v0.9.9
* version v0.9.10
* MIT Licensed
* Felipe Figueroa (amenadiel@gmail.com)
* https://github.com/HuasoFoundries/turf-google-maps
Expand Down
2 changes: 1 addition & 1 deletion dist/utils.js
@@ -1,7 +1,7 @@

/*
* turf-google-maps
* version v0.9.9
* version v0.9.10
* MIT Licensed
* Felipe Figueroa (amenadiel@gmail.com)
* https://github.com/HuasoFoundries/turf-google-maps
Expand Down
4 changes: 2 additions & 2 deletions generate_docs.js
Expand Up @@ -17,7 +17,7 @@ var readmeLinks = {
},
buffer: {
label: 'buffer',
description: 'Takes a google.maps.Polyline or google.maps.Polygon and returna a Feature of type Polygon or MultiPolygon surrounding the former at a specified distance' // eslint-disable-line max-len
description: 'Takes a google.maps.Polyline or google.maps.Polygon and returns a Feature of type Polygon or MultiPolygon surrounding the former at a specified distance' // eslint-disable-line max-len
},
concave: {
label: 'concave',
Expand Down Expand Up @@ -113,7 +113,7 @@ function generateDocs(fileObj, callback) {
});
}).then(output => {
let label = `${fileObj.filename}`,
link = `docs/${fileObj.subfolder}/${fileObj.filename}.md`;
link = `docs/${fileObj.filename}.md`;

readmeLinks[label] = readmeLinks[label] || {
label: label,
Expand Down
2 changes: 1 addition & 1 deletion package.json
@@ -1,6 +1,6 @@
{
"name": "turf-google-maps",
"version": "0.9.9",
"version": "0.9.10",
"description": "A bridge to use Turf along with google Maps API",
"scripts": {
"test": "karma start",
Expand Down

0 comments on commit c4c5c5a

Please sign in to comment.