search

antoine-coulon / skott

All-in-one devtool to automatically analyze, search and visualize project modules and dependencies from JavaScript, TypeScript (JSX/TSX) and Node.js (ES6, CommonJS)
MIT License
669 stars 25 forks source link

Add `usage` point in README.md #86

Closed mnik01 closed 1 year ago

mnik01 commented 1 year ago

Please provide better documentation for usage.

It should tell how to install and use the tool. Because now it's not clear for me.

antoine-coulon commented 1 year ago

Hello, there is a Documentation section in the root monorepo README.md that binds to https://github.com/antoine-coulon/skott/blob/main/packages/skott/README.md. What else do you suggest? I can try to make it clearer that the root README.md is just the presentation, not the documentation of the tool itself

antoine-coulon commented 1 year ago

Here is the documentation section I'm referring to

mnik01 commented 1 year ago

Sorry. My bad, didn't notice it at first

Thank you for answering

antoine-coulon commented 1 year ago

All good @mnik01 thanks to you for opening that issue!

antoine-coulon commented 1 year ago

Hello @mnik01, just updated the README.md as you suggested. Hope that's better now.

Cheers