UNPKG

sugardd.js

Version:

A sweet and structured project explorer that visualizes your codebase with beautiful tree diagrams and deep analysis. Perfect for any project.

45 lines (29 loc) 1.7 kB
# 🍭 sugardd.js <p align="center"> <img src="https://img.shields.io/npm/v/sugardd.js.svg?style=for-the-badge" alt="NPM Version"/> <img src="https://img.shields.io/github/license/cloud-dark/sugardd.js.svg?style=for-the-badge" alt="MIT License"/> <img src="https://img.shields.io/badge/node-%3E%3D14.0.0-brightgreen.svg?style=for-the-badge" alt="Node Version"/> </p> **A sweet and structured project explorer to visualize your codebase with beautiful tree diagrams and in-depth analysis.** ----- ## 🚀 Installation To use `sugardd.js` globally from your terminal, make sure you have Node.js (v14.0.0 or later) installed. Then, run the following command: ```bash npm install -g sugardd.js ``` Once the installation is complete, you can run the `sugardd` command from any directory. ## 📖 Full Documentation For a complete guide on features, command list, and usage examples, please refer to our full documentation. ### ➡️ **[Lihat Dokumentasi Lengkap (Bahasa Indonesia)](./docs/id.md)** ### ➡️ **[View Full Documentation (English)](./docs/en.md)** ## 🤝 Contributing We welcome contributions to `sugardd.js`! Whether it's fixing bugs, improving documentation, or adding new features, your help is appreciated. Please follow these steps to contribute: 1. Fork the repository. 2. Create a new branch for your feature or bug fix. 3. Make your changes and commit them with clear messages. 4. Push your changes to your fork. 5. Submit a pull request to the `main` branch of the original repository. ## 📄 License This project is licensed under the [MIT License](https://github.com/cloud-dark/sugardd.js/blob/main/LICENSE).