README
@beamwind/core
compiles Tailwind CSS like shorthand syntax into CSS at runtime
The core theme is bare bones as most projects have their own colors, sizes, ... and naming system. You probably want use one of the following:
- beamwind - using the tailwind default theme and preflight
- @beamwind/system - using a semantic design system and preflight
- @beamwind/play - combining the tailwind default theme, the semantic design system and preflight with auto-conversion of unknown theme values
Installation
npm install @beamwind/core
And then import it:
import { bw } from '@beamwind/core'
Please refer to the main documentation for further information.
Contribute
Thanks for being willing to contribute!
This project is free and open-source, so if you think this project can help you or anyone else, you may star it on GitHub. Feel free to open an issue if you have any idea, question, or you've found a bug.
Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub
We are following the Conventional Commits convention.
