diff --git a/README.md b/README.md
index 309ad6f..9716f76 100644
--- a/README.md
+++ b/README.md
@@ -47,7 +47,7 @@ export const buttonVariants = compose({
variants: {
intent: {
primary: "bg-blue-500 text-white",
- secondary: "bg-gray-200 text-gray-800",
+ secondary: "bg-gray-200 text-black",
},
size: {
small: "text-sm",
@@ -126,10 +126,19 @@ export const cardVariants = compose({
defaultVariants: {
size: "small",
},
-});
+})();
+
+export const Card = () => {
+ // Usage
+ const { root, header, body } = cardVariants;
-// Usage
-const { root, header, body } = cardVariants({ size: "large" });
+ return (
+
+ );
+};
```
## Compound Variants
@@ -165,13 +174,35 @@ export const buttonVariants = compose({
responsiveVariants: ["intent"],
});
+// Usage in a React component
+import { twMerge } from "tailwind-merge";
+
+// class .font-bold will be applied as the condition is fulfilled.
+export const Button: React.FC<{}> = () => {
+ const { root } = buttonVariants;
+
+ return (
+
+ );
+};
+
// In your Tailwind config
import { generateSafeList } from "@busbud/tailwind-buddy";
import { buttonVariants } from "./path-to-your-variants";
export default {
// ... other Tailwind configurations ...
- safelist: generateSafeList([buttonVariants], ["sm", "md", "lg", "xl"]),
+ safelist: generateSafeList([buttonVariants], ["sm", "md", "lg", "xl"]), // those values are needed to tell what breakpoint you do support. Today we only support with TS the default tailwind breakpoints
+ //
};
```