Here's an updated README file referencing the contribution guide:

DirKit

DirKit is a CLI tool designed to simplify working with directory structures. It enables developers to generate, visualize, and export directory trees in an intuitive and user-friendly way.

Note: DirKit is in its initial stages of development. Stay tuned for updates and new features and bud fixes!

Features (Planned for Initial Release)

• Generate a directory tree for any given folder.
• Export directory structures to JSON format.
• Control the depth of the generated directory tree.
• Simple and straightforward CLI interface.

Installation

Currently, DirKit is under development and not yet published to npm. Once published, you can install it globally using:

npm install -g dirkit

Usage

After installing, you can use the dirkit command as follows:

npx dirkit generate <dir-path>

• Replace <dir-path> with the path of the directory you want to generate the tree for.

Example

npx dirkit generate ./my-project

This will generate a directory tree for the my-project folder and display it in the terminal.

Contribution

We welcome contributions to DirKit! If you'd like to contribute, please read our Contribution Guidelines for detailed instructions.

Future Enhancements

• Support for visual output (e.g., diagrams).
• Options to exclude certain files or folders.
• Integration with IDEs and editors for seamless usage.

Thank you for checking out DirKit! 🎉
Stay tuned for updates and let us know your feedback.