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

Update readme.md with correct instantiation and module import #110

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

ZeroPie
Copy link
Contributor

@ZeroPie ZeroPie commented Oct 13, 2020

No description provided.

@ZeroPie ZeroPie changed the title Update readme.md Update readme.md with correct instantiation and module import Oct 13, 2020
@FelixHenninger
Copy link
Owner

FelixHenninger commented Oct 13, 2020

Hi @ZeroPie, thanks a lot for your effort! I’m a bit hesitant to include this in the documentation right now, given that for example the import statement won’t work for most users — (I think) you’re assuming that folks have a complete parcel/webpack setup available so that they can import an NPM module, while the documentation is assuming that lab.js is available through a global variable (a UMD package loaded in the browser). I do think, though, that it would be super-valuable to document how to create your setup via parcel — would you consider creating a minimum setup for lab.js and parcel as a starterkit, similar to the single-page starterkit we ship with every release? I think that would be a great addition to the library, and it would be also amazing to document so that folks can use the NPM ecosystem more easily. Would you be up for that?

@ZeroPie
Copy link
Contributor Author

ZeroPie commented Oct 14, 2020

Hi Felix)
I understand, here is the kit :)
https://github.com/ZeroPie/lab.js-kit
Shall i close the pr?

@FelixHenninger
Copy link
Owner

Thanks! As noted on Slack, this is amazing 😍 If you like, would you amend this PR (or create a new one) that links to your repository in the documentation? I think maybe you could add a recipe about how to use lab.js with a bundler. Would love to provide your excellent kit some additional exposure!

Base automatically changed from master to main January 19, 2021 13:35
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