"readme": "# Tailwind Plugin for Bun\n\nThe Tailwind Plugin for Bun is a plugin designed to integrate [Tailwind CSS](https://github.com/tailwindlabs/tailwindcss) with the [Bun](https://github.com/oven-sh/bun). This plugin simplifies the process of using Tailwind CSS within your Bun projects, allowing you to easily compile Tailwind CSS files during the build process.\n\n## Installation\n\nYou can install the Tailwind Plugin via Bun:\n\n```bash\nbun install @alik6/bun-tailwind-plugin\n```\n\n# Usage\n\n## Importing\n\n```ts\nimport { tailwind } from \"@alik6/bun-tailwind-plugin\";\n```\n\n## Configuration\n\n```ts\nimport { tailwind } from \"@alik6/bun-tailwind-plugin\";\nimport { build } from \"bun\";\n\nbuild({\n entrypoints: [\"src/main.tsx\"],\n // If not explicitly set in 'outputFile', defaults to 'outdir/' if defined, otherwise 'dist/'.\n outdir: \"dist/\",\n plugins: [\n tailwind({\n // tailwind Configuration\n tailwindConfig: { content: [\"src/**/*.{tsx,html}\"] },\n // path for output css file\n outputFile: \"dist/styles.css\",\n // path of input file, created if not found with the default tailwind headers\n inputFile: \"src/styles.css\",\n // path where tailwind.config.js will be generated, useful for autocompletion, each time the build method is called the tailwind.config.js will be synced with `tailwindConfig`, recommended path is 'base dir of the project'\n configPath: '.'\n }),\n ],\n}).catch((e) => console.error(e));\n```\n\n# Contributing to @alik6/bun-tailwind-plugin\n\nWelcome to @alik6/bun-tailwind-plugin, We appreciate your interest in contributing.\n\n## Ways to Contribute\n\n1. **Reporting Bugs:** If you encounter a bug, please open an issue on GitHub and provide detailed information about the problem, including steps to reproduce it.\n\n2. **Requesting Features:** If you have an idea for a new feature or enhancement, you can submit a feature request on GitHub. Provide a clear description of the proposed feature and its use case.\n\n3. **Submitting Pull Requests:** If you'd like to contribute code, you can fork the repository, create a new branch, and submit a pull request with your changes. Please ensure that your code adheres to our coding standards and include relevant tests.\n\n## Getting Started\n\nTo get started with contributing, follow these steps:\n\n1. Fork the repository on GitHub.\n\n2. Clone your forked repository to your local machine.\n\n3. Create a new branch for your changes (`git checkout -b feature/my-feature`).\n\n4. Make your changes and commit them (`git commit -am 'Add my feature'`).\n\n5. Push your changes to your forked repository (`git push origin feature/my-feature`).\n\n6. Submit a pull request on GitHub.\n\n## License\n\nBy contributing to @alik6/bun-tailwind-plugin, you agree that your contributions will be licensed under the [MIT License](LICENSE.md).\n",
0 commit comments