From d892fab134ba92c45eac058d892650ef43a40c17 Mon Sep 17 00:00:00 2001 From: stephann <3025661+stephannv@users.noreply.github.com> Date: Fri, 22 Nov 2024 10:13:58 -0300 Subject: [PATCH] Update README --- README.md | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 47b51b56..d0eb8b33 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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: @@ -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