sane-topojson
Advanced tools
Comparing version 3.0.0 to 3.0.1
{ | ||
"name": "sane-topojson", | ||
"version": "3.0.0", | ||
"version": "3.0.1", | ||
"description": "Ready-to-use multi-layer topojson files", | ||
@@ -5,0 +5,0 @@ "main": "index.js", |
@@ -11,7 +11,7 @@ # sane-topojson | ||
**-->** Go to [Natural Earth CHANGELOG](https://github.com/nvkelso/natural-earth-vector/blob/master/CHANGELOG) | ||
This project encompasses the three step required to turn | ||
[Natural Earth Data](http://www.naturalearthdata.com/) into topojson files. | ||
Go to [Natural Earth CHANGELOG](https://github.com/nvkelso/natural-earth-vector/blob/master/CHANGELOG) | ||
These are: | ||
@@ -24,16 +24,12 @@ | ||
### Configuration | ||
### Usage | ||
In `./config.json`: | ||
``` | ||
npm install sane-topojson | ||
``` | ||
- `resolutions`: array of resolutions to output | ||
- `scopes`: array of scopes to output | ||
and import/require the `index.js` or the one of the `dist/` files. | ||
sane-topojson will output `resolution.length` times `scopes.length` topojson | ||
files. | ||
### Layers | ||
- `vectors`: array of layers making up each topojson file | ||
### Output | ||
A topojson with the `objects` field: | ||
@@ -73,3 +69,3 @@ | ||
geometries: [ | ||
{type: '', id: '', arcs: [], properties: {ct: [lon, lat]}}, | ||
{type: '', id: '', arcs: [], properties: {ct: [lon, lat], gu: 'ISO-3'}}, | ||
// ... | ||
@@ -84,5 +80,7 @@ ] | ||
latitude coordinates (in degrees East and degrees North respectively) of the | ||
centroid of the geometry's largest polygon in area. | ||
centroid of the geometry's largest polygon in area and `gu` stands for the | ||
"governing unit" for `subunits` features (i.e. the country where the subunit | ||
is). | ||
### Install | ||
### Development dependencies | ||
@@ -92,9 +90,16 @@ - Install gdal (info: | ||
[mac](https://trac.osgeo.org/gdal/wiki/BuildingOnMac)) | ||
- `npm i` | ||
- Install node.js dependencies | ||
### Configuration | ||
``` | ||
npm install sane-topojson | ||
``` | ||
In `./config.json`: | ||
- `resolutions`: array of resolutions to output | ||
- `scopes`: array of scopes to output | ||
sane-topojson will output `resolution.length` times `scopes.length` topojson | ||
files. | ||
- `vectors`: array of layers making up each topojson file | ||
## Credits | ||
@@ -101,0 +106,0 @@ |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
4066737
114
2