Readme cleanup, final API state

mapbox / shp-write

create and write to shapefiles in pure javascript

BSD 3-Clause "New" or "Revised" License

300 stars 187 forks source link

Readme cleanup, final API state #100

Closed sheindel closed 1 year ago

sheindel commented 1 year ago

Fixed some issues with backwards compatibility with API surface by better handling defaults for zip options.
Allow root zip file outputs
Made API truly no-options capable (fixed no types bug)
Updated README
Updated version

sheindel commented 1 year ago

@charlieforward9 after sleeping on this, and thinking about the version bump, I realized that my API really wasn't fully backwards compatible, so I updated our changes so it is now backwards compatible and an even more minimal startup experience. I also bumped the version, fixed a deprecated bug with the buffers, and allowed for root .zip folder placement (the goal of PR 53).

The API change also gets rid of the duplicated default options, which weren't helpful anyways.

charlieforward9 commented 1 year ago

@sheindel Looks good! Thanks for doing this. Looks like the last thing to do is publish to npm!