README.md in hyperloop-config-0.9.0 vs README.md in hyperloop-config-0.9.1
- old
+ new
@@ -1,7 +1,28 @@
# Hyperloop::Configuration
-This gem is used internally by other [Hyperloop](http://ruby-hyperloop.io) gems for keeping config settings.
+This gem is used internally by other [Hyperloop](http://ruby-hyperloop.io) gems for keeping config settings, and for registering client side autoload requirements.
+
+To indicate gems to be autoloaded on client side:
+
+```ruby
+require 'hyperloop-config'
+Hyperloop.require 'my-gem-name', gem: true
+Hyperloop.require_gem 'my-gem_name' # short for above
+Hyperloop.require_gem 'my-gem-name', server_only: true
+Hyperloop.require_gem 'my-gem-name', client_only: true
+Hyperloop.require 'path', tree: true # same as saying require_tree 'path' in a manifest file
+Hyperloop.require 'asset_name' # same as saying require 'asset_name' in a manifest file
+```
+
+The difference between `require_gem`, and `require` is that require_gem can be used inside a gem file spec.
+
+Once a gem file spec does a `Hyperloop.require_gem` the listed gem will be automatically added to the `hyperloop-loader` manifest. This means all you do is add a gem
+to rails, and it will get sent on to the client (plus any other dependencies you care to require.)
+
+The require method can be used in the hyperloop initializer as well to add code to the manifest (i.e. add a gem to that is not using Hyperloop.require_gem)
+
+To define an initializer:
```ruby
module Hyperloop
on_config_reset do
# anything you want to run when initialization begins