@reactufy/reactufy 1.0.0

package/README.md

@@ -0,0 +1,151 @@
+# Reactufy
+
+A modern React component library built on Bootstrap 5, providing a comprehensive set of customizable UI components with flexible styling options.
+
+## Installation
+
+```bash
+npm install reactufy
+# or
+yarn add reactufy
+# or
+pnpm add reactufy
+```
+
+## Quick Start
+
+### Option 1: Everything Included (Recommended for Quick Start)
+
+Import the complete CSS bundle that includes Bootstrap + Reactufy enhancements:
+
+```jsx
+import 'reactufy/dist/reactufy-complete.css';
+import { Button, Alert, Modal } from 'reactufy';
+
+function App() {
+  return (
+    <div>
+      <Alert color="primary">Hello Reactufy!</Alert>
+      <Button color="primary">Click me</Button>
+    </div>
+  );
+}
+```
+
+### Option 2: Custom Bootstrap Setup (Advanced)
+
+If you want to customize Bootstrap variables, import only Reactufy's enhancements:
+
+```scss
+// your-custom-bootstrap.scss
+$primary: #your-color;
+$font-family-base: 'Your Font';
+
+@import 'bootstrap/scss/bootstrap';
+```
+
+```jsx
+import './your-custom-bootstrap.css';
+import 'reactufy/dist/reactufy-overrides.css'; // Only Reactufy enhancements
+import { Button, Alert, Modal } from 'reactufy';
+```
+
+### Option 3: Mix and Match
+
+```jsx
+import 'reactufy/dist/bootstrap.css';        // Standard Bootstrap
+import 'reactufy/dist/reactufy-overrides.css'; // Reactufy enhancements
+import { Button, Alert, Modal } from 'reactufy';
+```
+
+## Available CSS Files
+
+| File | Size | Description |
+|------|------|-------------|
+| `reactufy-complete.css` | 267 KB | Bootstrap + Reactufy enhancements (all-in-one) |
+| `bootstrap.css` | 265 KB | Standard Bootstrap 5.3.7 |
+| `reactufy-overrides.css` | 1.6 KB | Only Reactufy enhancements (tooltips, popovers, layout) |
+
+## Components
+
+### Layout Components
+- **Container** - Responsive container with size options
+- **Row, Column** - Flexible grid system
+- **HStack, VStack** - Horizontal and vertical stacks
+- **Layout, LayoutHeader, LayoutSidebar, LayoutContent, LayoutFooter** - Page layout system
+
+### UI Components
+- **Alert** - Contextual feedback messages
+- **Badge** - Small count and labeling component
+- **Button, ButtonGroup** - Interactive buttons with variants
+- **Spinner** - Loading indicators
+- **Progress** - Progress bars with animation
+- **Tooltip** - Hover tooltips
+- **Popover** - Contextual popover overlays
+- **Icon** - SVG icon system
+- **Heading, Text** - Typography components
+- **Table** - Responsive tables
+
+### Complex Components
+- **Accordion** - Collapsible content panels
+- **Breadcrumb** - Navigation breadcrumbs
+- **Card** - Flexible content container
+- **Dropdown** - Dropdown menus
+- **ListGroup** - List of items
+- **Modal** - Dialog boxes
+- **Nav, Navbar** - Navigation components
+- **Offcanvas** - Sidebar drawer
+- **Pagination** - Page navigation
+- **Scrollspy** - Scroll-aware navigation
+- **Toast** - Notification messages
+
+## TypeScript Support
+
+Reactufy is built with TypeScript and includes full type definitions:
+
+```tsx
+import { Button, ButtonColor, ButtonSize } from 'reactufy';
+
+// Type-safe props
+<Button 
+  color={ButtonColor.Primary} 
+  size={ButtonSize.Lg}
+>
+  Click me
+</Button>
+```
+
+All components export their prop types and enums for type-safe development.
+
+## What's Included in Reactufy Enhancements
+
+The `reactufy-overrides.css` file includes:
+
+- **Tooltip positioning fixes** - Proper arrow centering
+- **Popover positioning fixes** - Consistent arrow placement
+- **Layout system** - Grid-based page layout with sidebar support
+
+These enhancements work with any Bootstrap setup, including your customized versions.
+
+## Browser Support
+
+- Chrome (latest)
+- Firefox (latest)
+- Safari (latest)
+- Edge (latest)
+
+## Documentation
+
+For full documentation, interactive examples, and API reference, visit [your-docs-url]
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+MIT © [Your Name]
+
+## Credits
+
+Built with [Bootstrap 5](https://getbootstrap.com/) and [React](https://react.dev/)