feat: install task creates an initializer; added more docs

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    phlex_storybook (0.2.0)
+    phlex_storybook (0.2.1)
       importmap-rails
       phlex-icons (~> 0.11.0)
       phlex-rails (~> 1.2)

README.md

@@ -75,6 +75,42 @@ Then run the installer:
 rails phlex_storybook:install
 ```
 
+By default, this creates an initializer at `config/initializers/phlex_storybook.rb`, which looks in
+`app/components` for your registered Phlex components. Those components should register themselves
+with the storybook. E.g.
+
+```ruby
+class HelloWorld < Phlex::HTML
+  register_component do
+    # component_category is optional, non-categorized components will appear under "Uncategorized"
+    component_category "Category 1"
+
+    # component_name is optional, it defaults to the name of your component
+    component_name "Good ol' Hello"
+
+    # component_description is optional
+    component_description "The typical programmer's first attempt..."
+
+    # component props are required if your component takes arguments in #initialize
+    component_props [
+      PhlexStorybook::Props::String.new(key: :who, placeholder: "Who do you want to say hello to?")
+    ]
+
+    # component stories are optional; they are predefined instances of your component
+    component_stories "Arnold" => { who: "Arnie Schwarzenegger" },
+                      "Reagan" => { who: "Ronnie" }
+  end
+
+  def initialize(who: "world")
+    @who = who
+  end
+
+  def view_template
+    div { "hello #{@who}!" }
+  end
+end
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](LICENSE).

lib/phlex_storybook/tasks/install.rb

@@ -9,6 +9,20 @@ class Install < Thor
       def install
         say "Adding phlex_storybook to your application manifest..."
         append_to_file("app/assets/config/manifest.js", "//= link phlex_storybook_manifest.js\n")
+        create_file("config/initializers/phlex_storybook.rb") do
+          <<~RUBY
+            # frozen_string_literal: true
+            #
+            # Make sure to add register_component blocks to your components
+            #
+            # Example:
+            # register_component do
+            #   component_category "Category 1"
+            # end
+
+            Dir[Rails.root.join("app/components/**/*.rb").to_s].each { |file| require file }
+          RUBY
+        end
       end
     end
   end

lib/phlex_storybook/version.rb

@@ -1,3 +1,3 @@
 module PhlexStorybook
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

phlex_storybook.gemspec

@@ -15,11 +15,13 @@ Gem::Specification.new do |spec|
 
       $ bin/rails phlex_storybook:install
 
-    Then add phlex_storybook to your application by mounting it in your `config/routes.rb` file:
+    Then, add phlex_storybook to your application by mounting it in your `config/routes.rb` file:
 
       Rails.application.routes.draw do
         mount PhlexStorybook::Engine => "/phlex_storybook"
       end
+
+    If necessary, update the `config/initializers/phlex_storybook.rb` file with the path(s) to your components.
   MESSAGE
 
   spec.metadata["homepage_uri"]    = spec.homepage

test/dummy/config/application.rb

@@ -24,8 +24,6 @@ class Application < Rails::Application
     config.autoload_paths << "#{root}/app/components"
     config.load_defaults Rails::VERSION::STRING.to_f
 
-    Dir["#{root}/app/components/**/*.rb"].each { |file| require file }
-
     # For compatibility with applications that use this config
     config.action_controller.include_all_helpers = false
 

test/dummy/config/initializers/phlex_storybook.rb

@@ -1,2 +1,3 @@
-PhlexStorybook.configure do |config|
-end
+# frozen_string_literal: true
+
+Dir[Rails.root.join("app/components/**/*.rb").to_s].each { |file| require file }