add contributing guide to readme

README.md

@@ -48,3 +48,36 @@ Here is the list of components that are being built. For reference, see here htt
 ⚪️ Toggle
 ✅ Tooltip
 ✅ Typography
+
+## Contributing - Local Development Setup
+
+### Install the Gem Locally
+
+To contribute to this project, it's recommended to install the gem locally and point to it in your Gemfile:
+
+```ruby
+gem "rbui", path: "../rbui"
+```
+
+### Link the JavaScript Package
+
+Similarly, link the rbui-js package locally using yarn:
+
+```bash
+yarn add ../rbui
+```
+
+## Working with Components
+
+### Component Development Workflow
+
+1. Eject the component you want to modify using the generator:
+   ```bash
+   rails generate rbui:component combobox
+   ```
+2. Make your desired changes to the ejected component
+3. Once you're satisfied with the modifications, integrate the component back into the gem in the appropriate location
+
+This workflow allows you to iterate quickly on components while maintaining the gem's structure.
+
+Would you like me to expand on any part of the contributing guide?

package.json

@@ -11,7 +11,7 @@
     "esbuild": "0.23.0",
     "lottie-web": "5.12.2",
     "postcss": "8.4.40",
-    "rbui-js": "^1.0.0-alpha.4",
+    "rbui-js": "rbui-labs/rbui",
     "tailwindcss": "3.4.7",
     "tailwindcss-animate": "1.0.7"
   },

yarn.lock

@@ -819,10 +819,21 @@ queue-microtask@^1.2.2:
   resolved "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz"
   integrity sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==
 
-rbui-js@^1.0.0-alpha.4:
-  version "1.0.0-alpha.4"
-  resolved "https://registry.yarnpkg.com/rbui-js/-/rbui-js-1.0.0-alpha.4.tgz#f8cb252609217869692d15b6e662a31f3ec6342b"
-  integrity sha512-C1wRwuw6LjY0SEopvdi/sONBreehTzJla1ZH/E0t1TEne7Rx/R8RwPj+xhuxS/BOj/jwIc9goFKLro+3kbSo2w==
+rbui-js@../rbui:
+  version "1.0.0-alpha.3"
+  dependencies:
+    "@floating-ui/dom" "^1.6.8"
+    "@hotwired/stimulus" "^3.2.2"
+    chart.js "^4.4.1"
+    date-fns "^2.30.0"
+    fuse.js "^7.0.0"
+    motion "^10.16.4"
+    mustache "^4.2.0"
+    tippy.js "^6.3.7"
+
+rbui-js@rbui-labs/rbui:
+  version "1.0.0-alpha.3"
+  resolved "https://codeload.github.com/rbui-labs/rbui/tar.gz/301f325d1161a59ffdfecb02403754f8dad30c37"
   dependencies:
     "@floating-ui/dom" "^1.6.8"
     "@hotwired/stimulus" "^3.2.2"