Skip to content

Commit 5f0b705

Browse files
author
Connor Brown
authored
Merge pull request #102 from mapbox/updated_readme_and_module_names
Updated README and fixed module name
2 parents 5f707a4 + 76f3ed4 commit 5f0b705

File tree

3 files changed

+11
-7
lines changed

3 files changed

+11
-7
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,17 @@ ZIP file downloads in-browser.
88

99
## Usage
1010

11-
For node.js or [browserify](https://github.com/substack/node-browserify)
11+
For npm
1212

13-
npm install --save shp-write
13+
npm install --save @mapbox/shp-write
14+
15+
Yarn
16+
17+
yarn add @mapbox/shp-write
1418

1519
Or in a browser
1620

17-
https://unpkg.com/shp-write@latest/shpwrite.js
21+
https://unpkg.com/@mapbox/shp-write@latest/shpwrite.js
1822

1923
## Caveats
2024

@@ -27,7 +31,7 @@ Or in a browser
2731
## Minimal Example
2832

2933
```js
30-
var shpwrite = require("shp-write");
34+
var shpwrite = require("@mapbox/shp-write");
3135

3236
// a GeoJSON bridge for features
3337
const zipData = shpwrite.zip(
@@ -63,7 +67,7 @@ const zipData = shpwrite.zip(
6367
## Options Example
6468

6569
```js
66-
var shpwrite = require("shp-write");
70+
var shpwrite = require("@mapbox/shp-write");
6771

6872
const options = {
6973
folder: "my_internal_shapes_folder",

dist/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
declare module "shp-write" {
1+
declare module "@mapbox/shp-write" {
22
export enum OGCGeometry {
33
NULL,
44
POINT,

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@mapbox/shp-write",
3-
"version": "0.4.1",
3+
"version": "0.4.2",
44
"description": "write shapefiles from pure javascript",
55
"main": "dist/index.js",
66
"types": "dist/index.d.ts",

0 commit comments

Comments
 (0)