Skip to content

Commit 08045f3

Browse files
committed
Update docs
1 parent fa89811 commit 08045f3

File tree

3 files changed

+12
-7
lines changed

3 files changed

+12
-7
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
- [2025-12-06] [Update docs](https://github.com/RubricLab/ui/commit/f4223f72d0351c410101f557a41c2c7693ea7e6b)
12
- [2025-11-19] [Add optional classNames to all components for developer convenience without adding classNames to zod schemas](https://github.com/RubricLab/fabric-ui/commit/b1f4809712893d5a03c39237890396a77ac894f8)
23
- [2025-11-12] [Wrap codeblock commas and brackets. Patch toggle contrast.](https://github.com/RubricLab/ui/commit/9af47b64492a33f6467f19bc4c797696738a1bce)
34
- [2025-11-12] [Bump zod v3 → v4](https://github.com/RubricLab/fabric-ui/commit/cb21b771d6c0750654944aa001c0e243afcddb3a)

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ Peer requirements:
1919
- react ^19.0.0
2020
- react-dom ^19.0.0
2121

22-
Recommended: Tailwind CSS for styling (`tailwindcss`, `postcss`, `autoprefixer`).
22+
Recommended: Tailwind CSS for styling (`tailwindcss` and `postcss`).
2323

2424
## Quickstart
2525

26-
1) Ensure Tailwind CSS is set up in your app (see Tailwind docs). Components render with utility classNames and look best with your Tailwind theme.
26+
1) Ensure Tailwind CSS is set up in your app (see [Tailwind docs](https://tailwindcss.com/docs/installation/using-postcss)). Components render with utility `className`s and look best with your Tailwind theme.
2727

2828
2) Import components directly from the package:
2929

@@ -34,9 +34,9 @@ export const Example = () => {
3434
return (
3535
<Container>
3636
<Form>
37-
<Input placeholder="Title" />
38-
<Button type="submit" label="Save" />
39-
</Form>
37+
<Input placeholder="Title" />
38+
<Button type="submit" label="Save" />
39+
</Form>
4040
</Container>
4141
)
4242
}
@@ -105,9 +105,13 @@ Required tokens/variables:
105105
- muted-foreground → `--muted-foreground`
106106
- rounded → `--radius`
107107

108-
Recommended setup with Tailwind v4 (`@theme inline`) in your global CSS:
108+
Recommended setup with Tailwind v4 (`@theme inline`) in your `./globals.css`:
109109

110110
```css
111+
@import "tailwindcss";
112+
113+
@source "./node_modules/@rubriclab/ui";
114+
111115
:root {
112116
--background: #ffffff;
113117
--foreground: #171717;

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,5 +53,5 @@
5353
"post-commit": "bun x @rubriclab/package post-commit"
5454
},
5555
"types": "./src/index.ts",
56-
"version": "5.1.44"
56+
"version": "5.1.45"
5757
}

0 commit comments

Comments
 (0)