buildgrid-ui 1.15.15 → 1.15.16

package/README.md

@@ -22,49 +22,50 @@ To install the library, run:
 
 ```bash
 npm install buildgrid-ui
+# or
+yarn add buildgrid-ui
 ```
 
-or
+### Usage
 
-```bash
-yarn add buildgrid-ui
-```
+1.  **Import Components**: Import components directly into your React project:
 
----
+    ```jsx
+    import { Button } from "buildgrid-ui";
 
-### Usage
+    const App = () => <Button variant="primary">Click Me</Button>;
 
-1. Import a component in your React project:
+    export default App;
+    ```
 
-   ```jsx
-   import { Button } from "buildgrid-ui";
+2.  **Import Theme Styles**: Import the library's theme styles. This should be done once in your application's entry point (e.g., `src/main.tsx`, `src/index.tsx`, or `pages/_app.tsx` for Next.js):
 
-   const App = () => <Button variant="primary">Click Me</Button>;
+    ```javascript
+    // For JavaScript/TypeScript files
+    import 'buildgrid-ui/theme';
+    ```
 
-   export default App;
-   ```
+    If you are using a CSS file for global imports, you can add:
 
-2. Ensure TailwindCSS is configured in your project. Add the following imports to your `styles.css` file (or equivalent):
+    ```css
+    /* For CSS files */
+    @import 'buildgrid-ui/theme';
+    ```
 
-   ```css
-   @tailwind base;
-   @tailwind components;
-   @tailwind utilities;
-   ```
+3.  **Configure TailwindCSS (for v3)**: Ensure TailwindCSS is configured in your project. Add the following content paths to your `tailwind.config.js` to include `buildgrid-ui`'s classes:
 
-3. Include the `tailwind.config.js` content paths for buildgrid-ui:
-   ```javascript
-   module.exports = {
-     content: [
-       "./src/**/*.{js,ts,jsx,tsx}",
-       "./node_modules/buildgrid-ui/**/*.{js,ts,jsx,tsx}",
-     ],
-     theme: {
-       extend: {},
-     },
-     plugins: [],
-   };
-   ```
+    ```javascript
+    module.exports = {
+      content: [
+        "./src/**/*.{js,ts,jsx,tsx}",
+        "./node_modules/buildgrid-ui/**/*.{js,ts,jsx,tsx}",
+      ],
+      theme: {
+        extend: {},
+      },
+      plugins: [],
+    };
+    ```
 
 ---
 
@@ -108,12 +109,12 @@ This project uses [semantic-release](https://semantic-release.gitbook.io/) for a
 
 ### Steps to Create a Pre-release
 
-1. Push changes to the designated pre-release branch (e.g., `alpha`):
-   ```bash
-   git checkout -b alpha
-   git push origin alpha
-   ```
-2. Pre-release versions (e.g., `1.0.0-alpha.1`) will be automatically created.
+1.  Push changes to the designated pre-release branch (e.g., `alpha`):
+    ```bash
+    git checkout -b alpha
+    git push origin alpha
+    ```
+2.  Pre-release versions (e.g., `1.0.0-alpha.1`) will be automatically created.
 
 ---
 
@@ -121,12 +122,12 @@ This project uses [semantic-release](https://semantic-release.gitbook.io/) for a
 
 Contributions are welcome! To contribute:
 
-1. Fork the repository.
-2. Create a new branch for your feature or bugfix.
-3. Submit a pull request with a detailed description of your changes.
+1.  Fork the repository.
+2.  Create a new branch for your feature or bugfix.
+3.  Submit a pull request with a detailed description of your changes.
 
 ---
 
 ## License
 
-This project is licensed under the [MIT License](LICENSE).
+This project is licensed under the [MIT License](LICENSE).

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "buildgrid-ui",
-	"version": "1.15.15",
+	"version": "1.15.16",
 	"homepage": "http://adrianomaringolo.github.io/buildgrid-ui",
 	"publishConfig": {
 		"access": "public"
@@ -20,7 +20,7 @@
 			"import": "./dist/buildgrid-ui.es.js",
 			"require": "./dist/buildgrid-ui.umd.js"
 		},
-		"./buildgrid-ui.css": "./dist/buildgrid-ui.css",
+		"./theme": "./dist/buildgrid-ui.css",
 		"./components/*": {
 			"types": "./dist/components/*/index.d.ts",
 			"import": "./dist/components/*/index.js",