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 usage examples #161

Closed
skitterm opened this issue Sep 15, 2022 · 0 comments
Closed

Provide usage examples #161

skitterm opened this issue Sep 15, 2022 · 0 comments
Labels

Comments

@skitterm
Copy link

skitterm commented Sep 15, 2022

Hi there, thanks for providing this package which makes it much easier to read the various lockfile formats.

From the README I was unsure how to use this package (do I npm-install it?), and what functions I could call once it's imported. From a look in /lib/index.ts I assume I'm looking for buildDepTreeFromFiles.

It would also be helpful to have each exposed function and its parameters (does manifest mean like the package.json file?) and return types documented, or at minimum a usage example of buildDepTreeFromFiles on the README. I think I've got it figured out now, but it'd be much smoother with some docs up-front. Thanks!

@github-actions github-actions bot added the Stale label May 15, 2024
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale May 23, 2024
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

1 participant