Universe Setup

Universe Setup is a powerful CLI tool designed to help developers quickly start projects with pre-configured templates and integrated technologies. It provides a range of ready-to-use templates that make bootstrapping a new project faster and easier.

Getting Started

To begin setting up your project, run the following command:

npx universe-setup@latest

You will be prompted with the following questions to configure your project:

? Please enter the name of your project: (my-project)
? Which framework do you want to use? (Use arrow keys)
? Which UI library do you want to use? (Use arrow keys)
? Do you want to auto-install dependencies? (y/N)

Optional:

Vite

If you choose Vite as your framework, you'll be asked an additional question:

? Which Vite framework do you want to use? (Use arrow keys)

Contributing

We welcome contributions to Universe Setup! If you have a template, framework, or technology that you'd like to add, please feel free to submit a pull request.

How to Contribute:

1. Fork the repository - Click the 'Fork' button at the top-right of this repository to create a personal copy.
2. Create a new template - Add a new template under the appropriate directory (e.g., templates/).
3. Test your changes - Make sure your template is working correctly and doesn't break the CLI functionality.
4. Submit a pull request - Once you're satisfied with your changes, submit a pull request to the main branch.

Template Guidelines:

• Ensure your template is well-documented.
• Include instructions on how to configure the template if necessary.
• Templates should be widely applicable and follow common best practices.
• Try to ensure that templates are easy to use and maintainable.

Issues

If you encounter any bugs or have feature requests, please open an issue in the Issues section.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

If you need help or have questions, feel free to reach out to the maintainers or open an issue. We're here to help!

Thanks for using Universe Setup! We hope it helps you get your projects off the ground faster and more efficiently. Happy coding!

Key Sections:

1. Universe Setup Introduction: Explains what the project is, what it does, and why it’s useful for developers.
2. Getting Started: Provides clear instructions on how to use the CLI tool and configure the project.
3. Contributing: Encourages others to contribute, with a step-by-step guide to submitting pull requests and adding new templates.
4. Template Guidelines: Ensures that contributors follow best practices when adding new templates.
5. Issues: Gives instructions on how to report bugs or request features.
6. License: Specifies the MIT license for the project.
7. Support: Offers a way for users to get help.

This version of the README.md is clear, welcoming, and structured professionally, making it easy for developers to understand and contribute.