adminium 1.0.1-beta.3 → 1.0.1-beta.5

package/README.md

@@ -28,21 +28,27 @@ npm install react react-dom tailwindcss
 
 ## Quick Start
 
-### 1. Import the theme CSS
+### 1. Import styles (choose one approach)
 
-Add the theme CSS to your global styles or root layout:
+If your app already uses Tailwind (recommended), import the library styles into
+your global CSS so Tailwind can generate both your app utilities and the library
+utilities:
 
-```tsx
-// In your root layout or _app.tsx
-import "@metronic/ui/styles";
+```css
+@import "tailwindcss";
+@import "adminium/styles/global.css";
 ```
 
-Or import directly in your CSS:
+If you do not use Tailwind in the host app, import the precompiled CSS instead
+(your app won't have Tailwind utilities like `lg:flex`):
 
-```css
-@import "@metronic/ui/src/styles/theme.css";
+```tsx
+import "adminium/styles/adminium.css";
 ```
 
+If you need style isolation later, we can reintroduce a scoped build that
+prefixes selectors with a wrapper class.
+
 ### 2. Use the components
 
 ```tsx
@@ -53,7 +59,7 @@ import {
   CardTitle,
   CardContent,
   Badge,
-} from "@metronic/ui";
+} from "adminium";
 
 function App() {
   return (
@@ -62,7 +68,7 @@ function App() {
         <CardTitle>Welcome</CardTitle>
       </CardHeader>
       <CardContent>
-        <p>Hello from Metronic UI!</p>
+        <p>Hello from Adminium UI!</p>
         <Button variant="primary" size="md">
           Get Started
         </Button>