improvements

Author: codergeek121

README.md

@@ -4,8 +4,24 @@
 
 This gem adds a simple way to automatically register custom elements in your `importmap-rails` app. No build step required!
 
-- Supports `importmap-rails` v1 and v2.
-- Supports `rails` 7.0, 7.1 & 8.0.
+## Table of Contents
+
+<details>
+<summary>Click to expand</summary>
+
+- [Rails support](#rails-support)
+- [Installation](#installation)
+- [Generators](#generators)
+- [Documentation](#documentation)
+- [Contributing](#contributing)
+- [License](#license)
+
+</details>
+
+## Rails support
+
+* Supports Rails 7.0, 7.1, 7.2 & 8.0
+* Supports `importmap-rails` 1 and 2
 
 ## Installation
 
@@ -29,7 +45,7 @@ $ rails custom_elements:install
 
 This will setup and edit add the following files:
 
-```
+```graphql
 app/javascript
 ├── application.js
 └── custom_elements
@@ -43,13 +59,7 @@ You can generate a new custom element `<app-demo>` with `rails generate custom_e
 
 ### How It Works
 
-The `custom_elements-rails` gem uses `eagerDefineCustomElementsFrom` to automatically register [custom elements](https://developer.mozilla.org/en-US/docs/Web/API/Web_components/Using_custom_elements) from the `custom_elements` folder. It reads the importmap from `importmap-rails` and registers elements using `customElements.define(...)`.
-
-For example:
-
-```
-custom_elements/hello_element.js // Automatically registers <app-hello>
-```
+The `custom_elements-rails` gem uses `eagerDefineCustomElementsFrom` to automatically register [custom elements](https://developer.mozilla.org/en-US/docs/Web/API/Web_components/Using_custom_elements) in the `custom_elements` folder. It parses the importmap generated by `importmap-rails` and registers custom elements using the `customElements.define(...)` API.
 
 > [!IMPORTANT]  
 > Make sure your `*_element.js` files use `export default` to define the custom elements.
@@ -67,7 +77,7 @@ eagerDefineCustomElementsFrom("custom_elements", { prefix: "app" });
 ```
 
 | Filepath                            | Generated Custom Element Name |
-|-------------------------------------|--------------------------------|
+|:-----------------------------------:|:------------------------------:|
 | `custom_elements/demo_element.js`   | `<app-demo>`                  |
 | `custom_elements/demo-element.js`   | `<app-demo>`                  |
 | `custom_elements/foo_bar_element.js`| `<app-foo-bar>`               |
@@ -79,7 +89,7 @@ eagerDefineCustomElementsFrom("custom_elements", { prefix: "app" });
 - The folder structure is reflected in the name using double hyphens (`--`) to separate folder names from the file name.
 - A [configurable prefix](#documentation) is added to the beginning of each custom element name.
 
-## Add a custom element with the built-in generator
+## Generators
 
 This gem adds a generator to generate new custom elements with:
 
@@ -144,7 +154,9 @@ Currently supported optional `options`:
 
 ## Contributing
 
-TODO
+1. Fork the repository.
+2. Create a feature branch.
+3. Submit a pull request with a detailed description of changes.
 
 ## License