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

3.0.0 #15

Merged
merged 20 commits into from Nov 5, 2019
Merged

3.0.0 #15

merged 20 commits into from Nov 5, 2019

Conversation

South-Paw
Copy link
Owner

@South-Paw South-Paw commented Sep 29, 2019

⚠️ This PR contains breaking changes.

Description

3.0.0 is focused around improving the documentation including a new documentation site as well as some improvements to the exported component and dependencies.

The major changes in 3.0.0 are that the package no longer includes the JSON maps for consumption - instead users will be directed to the docs site where they can download and save the same JSON files.

The other major change is that the SVG to JSON script is no longer inside of the package. It is intended that the converter will be moved online and the docs site will host this with instructions on how to structure your SVG for map conversion.

New documentation preview 🎉

Todo

  • Create new documentation site with Gatsby
  • Document component and basic usage
  • Migrate examples to new docs
  • Create online converter for new docs
  • Complete test coverage
  • Update readme
  • Alpha publish to npm
  • Test alpha publish
  • Release 3.0.0

Related issues

closes #13
fixes #16

@South-Paw South-Paw self-assigned this Sep 29, 2019
@South-Paw South-Paw added this to the 3.0.0 milestone Sep 29, 2019
@South-Paw South-Paw mentioned this pull request Sep 29, 2019
@South-Paw
Copy link
Owner Author

South-Paw commented Sep 29, 2019

Eslint build error is currently blocked by eslint/eslint#12335

@South-Paw
Copy link
Owner Author

3.0.0 documentation preview

If anyone else happens to be reading this and has feedback, I'd be happy to hear it as well 👍

@South-Paw South-Paw marked this pull request as ready for review October 19, 2019 06:09
@South-Paw South-Paw merged commit ec52ad9 into master Nov 5, 2019
@South-Paw South-Paw deleted the 3.0.0 branch November 5, 2019 11:32
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.

SVG to JSON converter not working for Mac paths Improve documentation and examples
1 participant