Skip to content

Commit

Permalink
Merge pull request #102 from mapbox/updated_readme_and_module_names
Browse files Browse the repository at this point in the history
Updated README and fixed module name
  • Loading branch information
Connor Brown authored Aug 22, 2023
2 parents 5f707a4 + 76f3ed4 commit 5f0b705
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 7 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,17 @@ ZIP file downloads in-browser.

## Usage

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

npm install --save shp-write
npm install --save @mapbox/shp-write

Yarn

yarn add @mapbox/shp-write

Or in a browser

https://unpkg.com/shp-write@latest/shpwrite.js
https://unpkg.com/@mapbox/shp-write@latest/shpwrite.js

## Caveats

Expand All @@ -27,7 +31,7 @@ Or in a browser
## Minimal Example

```js
var shpwrite = require("shp-write");
var shpwrite = require("@mapbox/shp-write");

// a GeoJSON bridge for features
const zipData = shpwrite.zip(
Expand Down Expand Up @@ -63,7 +67,7 @@ const zipData = shpwrite.zip(
## Options Example

```js
var shpwrite = require("shp-write");
var shpwrite = require("@mapbox/shp-write");

const options = {
folder: "my_internal_shapes_folder",
Expand Down
2 changes: 1 addition & 1 deletion dist/index.d.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
declare module "shp-write" {
declare module "@mapbox/shp-write" {
export enum OGCGeometry {
NULL,
POINT,
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@mapbox/shp-write",
"version": "0.4.1",
"version": "0.4.2",
"description": "write shapefiles from pure javascript",
"main": "dist/index.js",
"types": "dist/index.d.ts",
Expand Down

0 comments on commit 5f0b705

Please sign in to comment.