Skip to content

Commit e6d449a

Browse files
authored
Update README (#204)
1 parent 8909f0e commit e6d449a

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
# RubyUI (former PhlexUI) 🚀
22

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

6-
## About RubyUI 📚
5+
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.
76

8-
RubyUI is a UI component library designed to let Ruby developers create modern, fast, and organized applications. 💎
7+
Pick the components you need. Copy and paste the code into your project and customize to your needs. The code is yours.
8+
9+
Use this as a reference to build your own component libraries.
910

1011
### Key Features:
1112

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

3031
```bash
31-
bundle add ruby_ui
32+
bundle add ruby_ui --group development --require false
3233
```
3334

3435
or add it to your Gemfile:
3536

3637
```ruby
37-
gem "ruby_ui"
38+
gem "ruby_ui", group: :development, require: false
3839
```
3940

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

4647
### 3. Done! 🎉
4748

49+
You can generate your components using `ruby_ui:component` generator.
50+
51+
```bash
52+
bin/rails g ruby_ui:component Accordion
53+
```
54+
4855
## Documentation 📖
4956

50-
Visit https://ruby_ui.dev/docs/introduction to view the full documentation, including:
57+
Visit https://rubyui.com to view the full documentation, including:
5158

5259
- Detailed component guides
5360
- Themes

0 commit comments

Comments
 (0)