okonomi_ui_kit 0.1.6 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c9f6e01883b276ac9f9698f3d62b837b2b015e43c58928c2dce2a8f7d989ec9
-  data.tar.gz: 70f433e695cec861ff14035220709e8d56115b4747d18e4397b342d8f5693e0d
+  metadata.gz: 24a820c59804a18c24872be13e80062bd25cfb96fe7d6da83eaee5e94b6e7ac0
+  data.tar.gz: e4dd1e222ac1593f098fc5f49e1a8b322aee75612b087ca62f6610822b6ed963
 SHA512:
-  metadata.gz: b1477d7d86ad3def41842194405981bfcaed050bde961961f1e75f74ccc7057b9c0dbd4c06686f1c6639042e17bfef01fe5947a27fc895f516f257c878ac3f68
-  data.tar.gz: 3ac01a8f7d26c04b62b3af528e32003f98b59f4caa06da35fd1f974e36017b7fe4c21589a32bf3ca50d14eecee641a719871ee7bb1b2ef3f3bef15652de4a503
+  metadata.gz: 7c800c4444d8f97f83898e8cb58a51f56746602fddc398a902412c6984501c86f9b653420dcbec5e5dd5c0bc5d208db86b2e291b8288de596e11e27b78e92284
+  data.tar.gz: 10047841cc202597d69470676eae295f7fa4215c3580d8183f855b92bd197b8b425d849097962ec47e49046d24bb3e18e9014d2bbfb3cee0a98144365953e758

data/README.md

@@ -1,10 +1,20 @@
 # OkonomiUiKit
-Short description and motivation.
 
-## Usage
-How to use my plugin.
+A Rails Engine gem that provides customizable, Tailwind CSS-based UI components for Rails applications. Built with maximum flexibility in mind, OkonomiUiKit allows you to maintain consistent design patterns across projects while giving you complete control over styling and behavior.
+
+## Features
+
+- **🎨 Fully Customizable** - Override any component's styling through a powerful configuration system
+- **🚀 Rails Native** - Built as a Rails Engine following Rails conventions
+- **💨 Tailwind CSS** - Modern utility-first CSS with intelligent class merging
+- **⚡ Stimulus Powered** - Progressive enhancement with Stimulus controllers
+- **🔧 Form Builder** - Enhanced form helpers with consistent styling
+- **📦 Component Library** - Pre-built components including buttons, badges, tables, alerts, and more
+- **🎯 Theme System** - Centralized theme configuration with variant support
+- **🔄 Smart Style Merging** - Intelligent Tailwind class conflict resolution
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -16,13 +26,159 @@ And then execute:
 $ bundle
 ```
 
-Or install it yourself as:
-```bash
-$ gem install okonomi_ui_kit
+In your application layout, include the CSS and JavaScript:
+
+```erb
+<%= stylesheet_link_tag "okonomi_ui_kit/application.tailwind", "data-turbo-track": "reload" %>
+<%= javascript_importmap_tags "okonomi_ui_kit" %>
+```
+
+## Quick Start
+
+### Using Components
+
+OkonomiUiKit provides a `ui` helper that gives you access to all components:
+
+```erb
+<%= ui.button "Click me", variant: :contained, color: :primary %>
+<%= ui.badge "New", color: :success %>
+<%= ui.alert "Welcome to OkonomiUiKit!", variant: :info %>
+```
+
+### Using the Form Builder
+
+```erb
+<%= form_with model: @user, builder: OkonomiUiKit::FormBuilder do |f| %>
+  <%= f.field_set do %>
+    <%= f.field :email do %>
+      <%= f.email_field :email %>
+    <% end %>
+    
+    <%= f.field :password do %>
+      <%= f.password_field :password %>
+    <% end %>
+  <% end %>
+  
+  <%= f.submit "Sign Up", color: :primary %>
+<% end %>
+```
+
+## Available Components
+
+### Core Components
+- **Button** - Buttons with multiple variants (contained, outlined, text)
+- **Badge** - Status indicators and labels
+- **Alert** - Notification messages with icons
+- **Table** - Data tables with consistent styling
+- **Typography** - Headings and text with predefined styles
+- **Code** - Inline and block code display
+
+### Form Components
+- **Field** - Form field wrapper with label and error handling
+- **FieldSet** - Group related form fields
+- **Select** - Styled select dropdowns
+- **Checkbox/Radio** - Enhanced checkboxes and radio buttons
+- **File Upload** - Drag-and-drop file uploads
+
+### Navigation Components
+- **Dropdown** - Dropdown menus with Stimulus integration
+- **Breadcrumbs** - Navigation breadcrumbs
+- **Link** - Styled links with variants
+
+## Customization
+
+OkonomiUiKit is designed to be highly customizable. You can override component styles by creating configuration classes in your Rails application.
+
+### Quick Example
+
+```ruby
+# app/helpers/okonomi_ui_kit/configs/button_base.rb
+module OkonomiUiKit
+  module Configs
+    class ButtonBase < OkonomiUiKit::Config
+      register_styles :default do
+        {
+          root: "font-semibold transition-all duration-200",
+          contained: {
+            colors: {
+              primary: "bg-brand-500 hover:bg-brand-600"
+            }
+          }
+        }
+      end
+    end
+  end
+end
 ```
 
+## Documentation
+
+### Guides
+
+- [Style Overrides Guide](guides/style-overrides-guide.md) - Complete guide to customizing component styles
+- [Component Guide](docs/COMPONENT_GUIDE.md) - Creating custom components
+- [CLAUDE.md](CLAUDE.md) - AI assistant instructions and architecture details
+
+### Component Guides
+
+- [Breadcrumbs](guides/components/breadcrumbs.md) - Navigation breadcrumb trails
+- [Typography](guides/components/typography.md) - Text styling with semantic HTML elements
+- [Icon](guides/components/icon.md) - SVG icon rendering with theme support
+
+### Development
+
+For development setup and commands, see [CLAUDE.md](CLAUDE.md#development-commands).
+
+## Architecture Overview
+
+OkonomiUiKit is built as a Rails Engine with:
+
+- **Helper-based components** - Ruby methods that generate semantic HTML
+- **Centralized theme system** - Consistent styling across all components  
+- **Stimulus controllers** - Progressive enhancement for interactivity
+- **Tailwind CSS integration** - Modern utility-first styling
+- **Smart style merging** - Intelligent conflict resolution for Tailwind classes
+
 ## Contributing
-Contribution directions go here.
+
+We welcome contributions! Please follow these steps:
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+### Development Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/yourusername/okonomi_ui_kit.git
+cd okonomi_ui_kit
+
+# Install dependencies
+bundle install
+
+# Start the development server
+bin/dev
+
+# Run tests
+bin/rails test
+
+# Run linter
+bin/rubocop
+```
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Credits
+
+OkonomiUiKit is maintained by the Okonomi team. We're passionate about creating tools that make Rails development more enjoyable and productive.
+
+## Support
+
+- 📚 [Documentation](guides/)
+- 🐛 [Issue Tracker](https://github.com/yourusername/okonomi_ui_kit/issues)
+- 💬 [Discussions](https://github.com/yourusername/okonomi_ui_kit/discussions)