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

Provide appropriate full examples #167

Open
eslachance opened this issue Feb 19, 2024 · 2 comments
Open

Provide appropriate full examples #167

eslachance opened this issue Feb 19, 2024 · 2 comments
Labels

Comments

@eslachance
Copy link

2.1k stars, 16 contributors on this project and not a single one of you has ever had the time to write an example showing how to use/import in a node project, or how to properly import the library in a module script.

Don't assume that people inherently know how to use libraries where you only have npm install or links to the CDN - a lot of beginners want to use your stuff and do not have this pre-requisite information. It doesn't take much to write proper examples in a readme. Please do that!

@mourner
Copy link
Member

mourner commented Feb 19, 2024

I get your criticism, but I don't understand why you have to be so condescending in an issue report. Please be kind. This is free and open source. Maintainers are people with feelings too.

@Zxilly
Copy link

Zxilly commented Feb 20, 2024

You should look for a tutorial and then learn some of the basics, rather than expecting to see a start-from-scratch guide for every dependency library you use.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants