Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 14 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
# RubyUI (former PhlexUI) 🚀

A UI component library, crafted precisely for Ruby devs who want to stay organized and build modern apps, fast. ✨
**Use this to build your own component library** 🛠️
Beautifully designed components that you can copy and paste into your apps. Accessible. Customizable. Open Source.

## About RubyUI 📚
This is NOT a component library. It's a collection of re-usable components that you can generate or copy and paste into your apps.

RubyUI is a UI component library designed to let Ruby developers create modern, fast, and organized applications. 💎
Pick the components you need. Copy and paste the code into your project and customize to your needs. The code is yours.

Use this as a reference to build your own component libraries.

### Key Features:

Expand All @@ -28,13 +29,13 @@ RubyUI is a UI component library designed to let Ruby developers create modern,
### 1. Install the gem

```bash
bundle add ruby_ui
bundle add ruby_ui --group development --require false
```

or add it to your Gemfile:

```ruby
gem "ruby_ui"
gem "ruby_ui", group: :development, require: false
```

### 2. Run the installer:
Expand All @@ -45,9 +46,15 @@ bin/rails g ruby_ui:install

### 3. Done! 🎉

You can generate your components using `ruby_ui:component` generator.

```bash
bin/rails g ruby_ui:component Accordion
```

## Documentation 📖

Visit https://ruby_ui.dev/docs/introduction to view the full documentation, including:
Visit https://rubyui.com to view the full documentation, including:

- Detailed component guides
- Themes
Expand Down