Add a simple generator and expand the README

Author: codergeek121

README.md

@@ -1,6 +1,6 @@
 # Custom Elements with Rails
 
-This gem provides a small helper and installation scripts to use custom elements in conjunction with `importmap-rails`.
+This gem provides a small js-helper, installation and generators to use custom elements in conjunction with `importmap-rails`.
 
 ## Usage
 
@@ -33,14 +33,44 @@ app/javascript
     └── index.js
 ```
 
-You can now add the `<app-hello>` custom element in your app. No build step needed.
+You can now add the `<app-hello>` custom element in your HTML. No build step needed.
+
+## How it works
+
+`eagerDefineCustomElementsFrom("custom_elements", { prefix: "app" })` will parse the JSON-importmap rendered by the `importmap-rails` gem and register custom elements with `customElements.define(...)` to the browser's custom element registry.
+
+```
+custom_elements/hello_element.js // will register <app-hello>
+```
+
+Your `_element.js` files have to `export default` custom elements for this to work.
+
+> [!WARNING]  
+> Only single word elements are support currently.
+
 
 ## Add a custom element
 
-TODO
+Generate a new custom element with:
+
+```bash
+$ rails generate custom_element test 
+```
+
+This will generate 
+
+```
+app/javascript
+└── custom_elements
+    └── test_element.js
+```
+
+which in turn will register a `<app-test></app-test>` custom element.
 
 ## Contributing
-Contribution directions go here.
+
+TODO
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

lib/custom_elements/rails/version.rb

@@ -1,5 +1,5 @@
 module CustomElements
   module Rails
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

lib/generators/custom_element_generator.rb

@@ -0,0 +1,8 @@
+class CustomElementGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path("templates", __dir__)
+
+  def copy_custom_element
+    template "custom_element.js", "app/javascript/custom_elements/#{file_name}_element.js"
+  end
+end
+

lib/generators/templates/custom_element.js.tt

@@ -0,0 +1,9 @@
+export default class extends HTMLElement {
+  constructor() {
+    super()
+  }
+
+  connectedCallback() {
+    console.log("<%= file_name %>")
+  }
+}