esquery icon indicating copy to clipboard operation
esquery copied to clipboard

Add getting started / usage to readme

Open dy opened this issue 10 years ago • 2 comments

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?

dy avatar Feb 18 '15 05:02 dy

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

kristianmandrup avatar Oct 31 '16 15:10 kristianmandrup

I made this PR with usage docs

mandricore avatar Dec 05 '16 11:12 mandricore