Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme cleanup, final API state #100

Merged
merged 5 commits into from
Aug 21, 2023
Merged

Readme cleanup, final API state #100

merged 5 commits into from
Aug 21, 2023

Conversation

sheindel
Copy link
Contributor

@sheindel sheindel commented Aug 21, 2023

  • 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
Copy link
Contributor Author

sheindel commented Aug 21, 2023

@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
Copy link
Contributor

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

@sheindel sheindel deleted the readme_cleanup branch August 22, 2023 18:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants