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

Add getting started / usage to readme #44

Open
dy opened this issue Feb 18, 2015 · 2 comments
Open

Add getting started / usage to readme #44

dy opened this issue Feb 18, 2015 · 2 comments

Comments

@dy
Copy link

dy commented Feb 18, 2015

I’ve found that each time I use esquery I have a question how to use it? Is it conventional, like other estools: var query = require('esquery').query or is it plain function var query = require('esquery')? API is also not clear at first.
Examples could be found in tests, of course, but is there a sense to add short description to the readme, to give new users answer to such questions?

@kristianmandrup
Copy link

Please add proper docs. Someone please make a PR with good examples and overview of how to use the API. Cheers!

@mandricore
Copy link

I made this PR with usage docs

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

No branches or pull requests

3 participants