From 31217dd3dd14264dbd00e8067bb7d01639296586 Mon Sep 17 00:00:00 2001
From: David Alejandro
 <15317732+davidalejandroaguilar@users.noreply.github.com>
Date: Fri, 20 Sep 2024 00:29:12 +0200
Subject: [PATCH] Update README.md

---
 README.md | 52 +++++++++++++++++++++++++++++++++++++++-------------
 1 file changed, 39 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index 7db80e4..fe87aa1 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,50 @@
-# README
+This is the repo [for the docs](https://phlexyui.com/) of PhlexyUI, a Ruby UI component library for DaisyUI using Phlex ✨
 
-This README would normally document whatever steps are necessary to get the
-application up and running.
+# 🔧 Development
 
-Things you may want to cover:
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` to run the tests.
 
-* Ruby version
+# 💻 Contributing
 
-* System dependencies
+Bug reports and pull requests are welcome on GitHub at https://github.com/PhlexyUI/phlexy_ui_docs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/phlexy_ui/blob/main/CODE_OF_CONDUCT.md).
 
-* Configuration
+1. Visit [the docs](https://phlexyui.com/) to see which components are still not implemented or not yet added to the docs.
 
-* Database creation
+2. Implement it.
 
-* Database initialization
+3. After your PR is merged, add it to this repo.
 
-* How to run the test suite
+4. Celebrate 🎉
 
-* Services (job queues, cache servers, search engines, etc.)
+## Using the generators
 
-* Deployment instructions
+You can use the generators to make your life easier:
 
-* ...
+**New component**
+
+If you're adding a new component, use `bin/rails generate example_view`. This generates a new component example view and a basic component.
+
+e.g. `bin/rails generate example_view Card`
+
+This will create:
+
+- app/views/examples/cards/show_view.rb
+- app/views/components/examples/cards/basic_component.rb
+
+**New example**
+
+If you're adding a new example to an existing component, use `bin/rails generate example_component`. This generates a new component example.
+
+e.g. `bin/rails generate example_component Cards::Responsive "Optional title"`
+
+This will create:
+
+- app/views/components/examples/cards/responsive_component.rb
+
+# 📃 License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+# ☝️ Code of Conduct
+
+Everyone interacting in the PhlexyUI project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/phlexy_ui/blob/main/CODE_OF_CONDUCT.md).