Update README.md

Author: codergeek121

Diff for: README.md

@@ -1,10 +1,8 @@
-# Custom Elements with Rails
+# Custom Elements Rails
 
 [![Tests](https://github.com/codergeek121/custom_elements-rails/actions/workflows/ruby.yml/badge.svg?branch=main)](https://github.com/codergeek121/custom_elements-rails/actions/workflows/ruby.yml)
 
-This gem provides a small js-helper, installation scripts and generators to use custom elements in conjunction with the `importmap-rails` gem.
-
-## Usage
+This gem adds a simple way to automatically register custom elements in your `importmap-rails` app. No build step required!
 
 ## Installation
 
@@ -36,26 +34,27 @@ app/javascript
     └── index.js
 ```
 
-You can now add the `<app-hello>` custom element in your HTML. No build step needed.
+The `<app-hello>` custom element can be used in the views now.
+
+You can generate a new custom element with `rails g custom_element abc`.
 
 ## How it works
 
-`eagerDefineCustomElementsFrom` will parse the JSON-importmap rendered by the `importmap-rails` gem.
-It registers custom elements with `customElements.define(...)` in the browser's registry based on the filename automatically.
+The setup will add a JS function call `eagerDefineCustomElementsFrom` that parses the importmap rendered by the `importmap-rails` gem.
+It registers custom elements with `customElements.define(...)` in the browser's registry based on the filenames in the `custom_elements` folder automatically.
 
 ```
-custom_elements/hello_element.js // will register <app-hello>
+custom_elements/hello_element.js // will register <app-hello> automatically
 ```
 
 Your `*_element.js` files have to `export default` custom elements for this to work properly.
 
 > [!WARNING]  
 > Only single word elements are supported currently. See https://github.com/codergeek121/custom_elements-rails/issues/1
 
-
 ## Add a custom element
 
-Generate a new custom element with:
+This gem adds a generator to generate new custom elements with:
 
 ```bash
 $ rails generate custom_element test 
@@ -64,12 +63,28 @@ $ rails generate custom_element test
 This will generate 
 
 ```
-app/javascript
-└── custom_elements
-    └── test_element.js
+// app/javascript/custom_elements/test_element.js
+export default class extends HTMLElement {
+  constructor() {
+    super()
+  }
+
+  connectedCallback() {
+    console.log("test_element.js")
+  }
+}
+
 ```
 
-which in turn will register a `<app-test></app-test>` custom element.
+which in turn will register a `<app-test></app-test>` custom element automatically in your app.
+
+## Documentation
+
+`eagerDefineCustomElementsFrom(under, options)`
+
+Currently supported `options`:
+
+* `prefix`: The custom elements namespace/prefix.
 
 ## Contributing