braid-ui 1.0.3 → 1.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +28 -1
- package/dist/index.cjs +980 -977
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +55 -20
- package/dist/index.d.ts +55 -20
- package/dist/index.js +979 -979
- package/dist/index.js.map +1 -1
- package/package.json +12 -8
- package/src/styles.css +124 -0
package/README.md
CHANGED
|
@@ -5,7 +5,34 @@ A comprehensive React UI component library built with TypeScript, Tailwind CSS,
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
npm install braid-ui
|
|
8
|
+
npm install braid-ui
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Setup
|
|
12
|
+
|
|
13
|
+
**No additional setup required!** The styles are automatically bundled with the components.
|
|
14
|
+
|
|
15
|
+
However, if you want to customize the styling, you can configure Tailwind CSS in your project:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npm install -D tailwindcss postcss autoprefixer
|
|
19
|
+
npx tailwindcss init -p
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
Then update your `tailwind.config.js`:
|
|
23
|
+
|
|
24
|
+
```js
|
|
25
|
+
/** @type {import('tailwindcss').Config} */
|
|
26
|
+
module.exports = {
|
|
27
|
+
content: [
|
|
28
|
+
"./src/**/*.{js,ts,jsx,tsx}",
|
|
29
|
+
"./node_modules/braid-ui/dist/**/*.{js,ts,jsx,tsx}", // Add this line
|
|
30
|
+
],
|
|
31
|
+
theme: {
|
|
32
|
+
extend: {},
|
|
33
|
+
},
|
|
34
|
+
plugins: [],
|
|
35
|
+
}
|
|
9
36
|
```
|
|
10
37
|
|
|
11
38
|
## Usage
|