hyper-mesh 0.5.3 → 0.5.4

data/docs/activerecord_api.md

@@ -1,46 +1,48 @@
 ## ActiveRecord API
 
-HyperMesh uses a subset of the standard ActiveRecord API to give your client side HyperReact components access to your server side models.  As much as possible HyperMesh follows the syntax and semantics of ActiveRecord.  
+Hyperloop uses a subset of the standard ActiveRecord API to give your Isomorphic Components, Operations and Stores access to your server side Models.  As much as possible Hyperloop follows the syntax and semantics of ActiveRecord.  
 
 ### Interfacing to React
 
-HyperMesh integrates with React to deliver your model data to the client without you having to create extra APIs or specialized controllers.  The key idea of React is that when state (or params) change, the portions of the display effected by this data will be updated.
+Hyperloop integrates with React (through Components) to deliver your Model data to the client without you having to create extra APIs or specialized controllers.  The key idea of React is that when state (or params) change, the portions of the display effected by this data will be updated.
 
-HyperMesh automatically creates react state objects that will be updated as server side data is loaded or changes.  When these states change the associated parts of the display will be updated.
+Hyperloop automatically creates React state objects that will be updated as server side data is loaded or changes.  When these states change the associated parts of the display will be updated.
 
-A brief overview of how this works will help you understand the how HyperMesh gets the job done.
+A brief overview of how this works will help you understand the how Hypeloop gets the job done.
 
 #### Rendering Cycle
 
 On the UI you will be reading models in order to display data.
 
-If during the rendering of the display the model data is not yet loaded, placeholder values (the default values from the `columns_hash`) will be returned by HyperMesh.  
+If during the rendering of the display the Model data is not yet loaded, placeholder values (the default values from the `columns_hash`) will be returned by Hyperloop.  
 
-HyperMesh then keeps track of where these placeholders (or `DummyValue`s) are displayed, and when they do get loaded, those parts of the display will re-render.
+Hyperloop then keeps track of where these placeholders (or `DummyValue`s) are displayed, and when they do get loaded, those parts of the display will re-render.
 
 If later the data changes (either due to local user actions, or receiving push updates) then again any parts of the display that were dependent on the current values will be re-rendered.
 
-You normally do not have to be aware of this.  Just access your models using the normal scopes and finders, then compute values and display attributes as you would on the server.  Initially the display will show the placeholder values and then will be replaced with the real values.
+You normally do not have to be aware of this.  Just access your Models using the normal scopes and finders, then compute values and display attributes as you would on the server.  Initially the display will show the placeholder values and then will be replaced with the real values.
 
 #### Prerendering
 
-During server-side pre-rendering, HyperMesh has direct access to the server so on initial page load all the values will be loaded and present.  
+During server-side pre-rendering, Hyperloop has direct access to the server so on initial page load all the values will be loaded and present.  
 
 #### Lazy Loading
 
-HyperMesh lazy loads values, and does not load any thing until an explicit displayable value is requested.  For example `Todo.all` will have no action, but `Todo.all.pluck[:title]` will return an array of titles.
+Hyperloop lazy loads values, and does not load any thing until an explicit displayable value is requested.  For example `Todo.all` will have no action, but `Todo.all.pluck[:title]` will return an array of titles.
 
 At the end of the rendering cycle the set of all values requested will be merged into a tree structure and sent to the server, returning the minimum amount of data needed.
 
 #### Load Cycle Methods
 
+TODO check link below
+
 There are a number of methods that allow you to interact with this load cycle when needed.  These are documented [below](#other-methods-for-interacting-with-the-load-and-render-cycle).
 
 ### Class Methods
 
 #### New and Create
 
-`new`: Takes a hash of attributes and initializes a new unsaved record.  The values of any attributes not specified in the hash will be taken from the models default values specified in the `columns_hash`.
+`new`: Takes a hash of attributes and initializes a new unsaved record.  The values of any attributes not specified in the hash will be taken from the Models default values specified in the `columns_hash`.
 
 If `new` is passed a native javascript object it will be treated as a hash and converted accordingly.
 
@@ -48,7 +50,9 @@ If `new` is passed a native javascript object it will be treated as a hash and c
 
 #### Scoping and Finding
 
-`scope` and `default_scope`:  HyperMesh adds four new options to these methods: `joins`, `client`, `select` and `server`.  The `joins` option provides information on how the scope will be joined with other models.  The `client` and `select` options allow scoping to be done on the client side to offload this from the server, and the `server` option is there just for symmetry with the other options.  See the [Client Side Scoping](/docs/client_side_scoping.md) page for more details.
+`scope` and `default_scope`:  Hyperloop adds four new options to these methods: `joins`, `client`, `select` and `server`.  The `joins` option provides information on how the scope will be joined with other models.  The `client` and `select` options allow scoping to be done on the client side to offload this from the server, and the `server` option is there just for symmetry with the other options.  See the [Client Side Scoping](/docs/client_side_scoping.md) page for more details.
+
+TODO check link above
 
 ```ruby
 # the active scope proc is executed on the server
@@ -74,7 +78,7 @@ scope :completed,
 Word.all.each { |word| LI { word.text }}
 ```
 
-BTW: to save typing you can skip the `all`:  Models will respond like enumerators
+BTW: to save typing you can skip the `all`:  Models will respond like enumerators.
 
 `find`: takes an id and delivers the corresponding record.
 
@@ -94,7 +98,7 @@ Word.offset(500).limit(20) # get words 500-519
 
 #### Relationships and Aggregations
 
-`belongs_to, has_many, has_one`:  These all work as on the server.  However it is important that you fully specify both sides of the relationship.  
+`belongs_to, has_many, has_one`:  These all work as on the server.  **However it is important that you fully specify both sides of the relationship.**  
 
 ```ruby
 class Todo < ActiveRecord::Base
@@ -233,12 +237,14 @@ After the destroy completes the record's `destroyed?` method will return true.
 
 All Ruby objects will respond to these methods.  If you want to put up a "Please Wait" message, spinner, etc, you can use the `loaded?` or `loading?` method to determine if the object represents a real loaded value or not.  Any value for which `loaded?` returns `false` (or `loading?` returns `true`) will eventually load and cause a re-render
 
-#### The `HyperMesh.load` Method
+TODO check below (was HyperMesh.load)
+
+#### The `HyperModel.load` Method
 
-Sometimes it is necessary to insure values are loaded outside of the rendering cycle.  For this you can use the `HyperMesh.load` method:
+Sometimes it is necessary to insure values are loaded outside of the rendering cycle.  For this you can use the `HyperModel.load` method:
 
 ```ruby
-HyperMesh.load do
+HyperModel.load do
   x = my_model.some_attribute
   OtherModel.find(x+12).other_attribute
   # code in here can be arbitrarily complex and load
@@ -266,4 +272,4 @@ before_mount do
 end
 ```
 
-Think hard about how you are using this, as HyperMesh already acts as flux store, and is managing state for you.  It may be you are just creating a redundant store!
+Think hard about how you are using this, as Hyperloop already acts as flux store, and is managing state for you.  It may be you are just creating a redundant store!

data/docs/authorization-policies.md

@@ -1,6 +1,8 @@
-### HyperMesh Authorization Policies
+### Hyperloop Authorization Policies
 
-Access to your models is controlled by *Policies* that describe how the current *acting_user* and *channels* may access your models.
+TODO: Move this doc to a Policy Section
+
+Access to your Isomorphic Models is controlled by *Policies* that describe how the current *acting_user* and *channels* may access your Models.
 
 Each browser session has an *acting_user* (which may be nil) and you will define `create`, `update`, and `destroy` policies giving (or denying) the `acting_user` the ability to do these operations.
 
@@ -91,23 +93,23 @@ class ApplicationController < ActionController::Base
 end
 ```
 
-Note that `acting_user` is also used by Reactive-Record's permission system.
+Note that `acting_user` is also used by ReactiveRecord's permission system.
 
-Our entire set of policies is defined in 29 lines of code of which 8 actually execute the policies.  Our existing classes form the foundation, and we simply add synchromesh specific policy directives.  Pretty sweet huh?
+Our entire set of policies is defined in 29 lines of code of which 8 actually execute the policies.  Our existing classes form the foundation, and we simply add Hyperloop specific policy directives.  Pretty sweet huh?
 
 ### Details
 
-HyperMesh uses *Policies* to *regulate* what *connections* are opened between clients and the server and what data is distributed over those connections.
+Hyperloop uses *Policies* to *regulate* what *connections* are opened between clients and the server and what data is distributed over those connections.
 
 Connections are made on *channels* of data flowing between the server and a number of clients.  Each channel is associated with either a class or an instance of a class.  Typically the channel class represents an entity (or is associated with an entity) that can be authenticated like a `User`, an  `AdminUser`, or a `Team` of users.  A channel associated with the class itself broadcasts data that is received by any member of that class.  A channel associated with an instance is for data that is available only to that specific instance.   
 
-As models on the server change (i.e. created, updated, or destroyed) the changes are broadcast over open channels.  What specific attributes are sent (if any) is determined by broadcast policies.
+As Models on the server change (i.e. created, updated, or destroyed) the changes are broadcast over open channels.  What specific attributes are sent (if any) is determined by broadcast policies.
 
-Broadcast policies can be associated with models.  As the model changes the broadcast policy will regulate what attributes of the changed model will be sent over which channels.  
+Broadcast policies can be associated with Models.  As the Model changes the broadcast policy will regulate what attributes of the changed model will be sent over which channels.  
 
-Broadcast policies can also be associated with a channel and will regulate *all* model changes over specific channels.  In other words this is just a convenient way to associate a common policy with *all* models.
+Broadcast policies can also be associated with a channel and will regulate *all* model changes over specific channels.  In other words this is just a convenient way to associate a common policy with *all* Models.
 
-Note that models that are associated with channels can also broadcast their changes on the same or different channels.
+Note that Models that are associated with channels can also broadcast their changes on the same or different channels.
 
 #### Defining Policies and Policy Classes
 
@@ -130,13 +132,15 @@ class ApplicationPolicy
 end
 ```
 
-Note that by default policy classes go in the `app/policies` directory.  HyperMesh will require all the files in this directory.
+Note that by default policy classes go in the `app/policies` directory.  Hyperloop will require all the files in this directory.
+
+TODO check the name of the module below
 
-If you wish, you can also add policies directly in your models by including the `HyperMesh::PolicyMethods` module in your model.  You can then use the `regulate_class_connection`, `regulate_instance_connections`, `regulate_all_broadcasts` and `regulate_broadcast` methods directly in the model.
+If you wish, you can also add policies directly in your Models by including the `Hyperloop::PolicyMethods` module in your model.  You can then use the `regulate_class_connection`, `regulate_instance_connections`, `regulate_all_broadcasts` and `regulate_broadcast` methods directly in the model.
 
 ```ruby
 class User < ActiveRecord::Base
-  include HyperMesh::PolicyMethods
+  include Hyperloop::PolicyMethods
   regulate_class_connection ...
   regulate_instance_connections ...
   regulate_all_broadcasts ...  
@@ -161,12 +165,12 @@ end
 
 #### Channels and the connection policies
 
-Any ruby class that has a connection policy is a synchromesh channel. The fully scoped name of the class becomes the root of the channel name.
+Any ruby class that has a connection policy is a Hyperloop channel. The fully scoped name of the class becomes the root of the channel name.
 
 The purpose of having channels is to restrict what gets broadcast when models change, therefore typically channels represent *connections* to
 
 + the application, or some function within the application
-+ or some class which *authenticated* like a User or Administrator,
++ or some class which is *authenticated* like a User or Administrator,
 + instances of those classes,
 + or instances of related classes.
 
@@ -202,15 +206,15 @@ regulate_instance_connections { group }
 regulate_instance_connections { teams }
 ```
 
-#### Class Names, Instances and Ids
+#### Class Names, Instances and IDs
 
 While establishing connections, classes are represented as their fully scoped name, and instances are represented as the class name plus the result of calling `id` on the instance.
 
-Typically connections are made to ActiveRecord models, and if those are in the `app/models/public` folder everything will work fine.
+Typically connections are made to ActiveRecord models, and if those are in the `app/hyperloop/models` folder everything will work fine.
 
 #### Acting User
 
-HyperMesh looks for an `acting_user` method typically defined in the ApplicationController and would normally pick up the current session user, and return an appropriate object.
+Hyperloop looks for an `acting_user` method typically defined in the ApplicationController and would normally pick up the current session user, and return an appropriate object.
 
 ```ruby
 class ApplicationController < ActiveController::Base
@@ -244,7 +248,9 @@ Normally the client will automatically connect to the available channels when a
 manually connect on the client in response to some user action like logging in, or the user deciding to
 display a specific team status on their dashboard.
 
-To manually connect a client use the `HyperMesh.connect` method.  
+TODO check below Hyperloop.connect
+
+To manually connect a client use the `Hyperloop.connect` method.  
 
 The `connect` method takes any number of arguments each of which is either a class, an object, a String or Array.
 
@@ -252,7 +258,7 @@ If the argument is a class then the connection will be made to the matching clas
 
 ```ruby
 # connect the client to the AdminUser class channel
-HyperMesh.connect(AdminUser)
+Hyperloop.connect(AdminUser)
 # if the connection is successful the client will begin getting updates on the
 # AdminUser class channel
 ```
@@ -261,7 +267,7 @@ If the argument is an object then a connection will be made to the matching obje
 
 ```ruby
 # assume current_user is an instance of class User
-HyperMesh.connect(current_user)
+Hyperloop.connect(current_user)
 # current_user.id is used to establish which User instance to connect to on the
 # server
 ```
@@ -269,20 +275,20 @@ HyperMesh.connect(current_user)
 The argument can also be a string, which matches the name of a class on the server
 
 ```ruby
-HyperMesh.connect('AdminUser')
+Hyperloop.connect('AdminUser')
 # same as AdminUser class
 ```
 
 or the argument can be an array with a string and the id:
 
 ```ruby
-HyperMesh.connect(['User', current_user.id])
+Hyperloop.connect(['User', current_user.id])
 # same as saying current_user
 ```
 
 You can make several connections at once as well:
 ```ruby
-HyperMesh.connect(AdminUser, current_user)
+Hyperloop.connect(AdminUser, current_user)
 ```
 
 Finally falsy values are ignored.
@@ -290,25 +296,25 @@ Finally falsy values are ignored.
 You can also send `connect` directly to ActiveRecord models:
 
 ```ruby
-AdminUser.connect!    # same as HyperMesh.connect(AdminUser)
-current_user.connect! # same as HyperMesh.connect(current_user)
+AdminUser.connect!    # same as Hyperloop.connect(AdminUser)
+current_user.connect! # same as Hyperloop.connect(current_user)
 ```
 
 #### Connection Sequence Summary
 
 For class connections:
 
-1. The client calls `HyperMesh.connect`.
-2. HyperMesh sends the channel name to the server.
-3. HyperMesh has its own controller which will determine the `acting_user`,
+1. The client calls `Hyperloop.connect`.
+2. Hyperloop sends the channel name to the server.
+3. Hyperloop has its own controller which will determine the `acting_user`,
 4. and call the channel's `regulate_class_connection` method.
-5. If `regulate_class_connection` returns a truthy value then the connetion is made,
+5. If `regulate_class_connection` returns a truthy value then the connection is made,
 6. otherwise a 500 error is returned.
 
 For instance connections:
 
 1. The process is the same but the channel name and id are sent to the server.  
-2. The HyperMesh controller will do a find of the id passed to get the instance,
+2. The Hyperloop controller will do a `find` of the id passed to get the instance,
 3. and if successful `regulate_instance_connections` is called,
 4. which must return an either the same instance, or an enumerable with that instance as a member.
 5. Otherwise a 500 error is returned.
@@ -317,13 +323,15 @@ Note that the same sequence is used for auto connections and manually invoked co
 
 #### Disconnecting
 
-Calling `HyperMesh.disconnect(channel)` or `channel.disconnect!` will disconnect from the channel.
+TODO check Hyperloop.disconnect(
+
+Calling `Hyperloop.disconnect(channel)` or `channel.disconnect!` will disconnect from the channel.
 
 #### Broadcasting and Broadcast Policies
 
 Broadcast policies can be defined for channels using the `regulate_all_broadcasts` method, and for individual objects (typically ActiveRecord models) using the `regulate_broadcast` method.  A `regulate_all_broadcasts` policy is essentially a `regulate_broadcast` that will be run for every record that changes in the system.
 
-After an ActiveRecord model change is committed, all active class channels run their channel broadcast policies, and then the instance broadcast policy associated with the changing model is run.  So for any change there may be multiple channel broadcast policies involved, but only one (at most) regulate_broadcast.  
+After an ActiveRecord Model change is committed, all active class channels run their channel broadcast policies, and then the instance broadcast policy associated with the changing Model is run.  So for any change there may be multiple channel broadcast policies involved, but only one (at most) regulate_broadcast.  
 
 The result is that each channel may get a filtered copy of the record which is broadcast on that channel.
 
@@ -417,7 +425,7 @@ Each change access policy executes a block in the context of the record that wil
 
 If the block returns a truthy value access will be allowed, otherwise if the block returns a falsy value or raises an exception, access will be denied.
 
-In the below examples we assume that your user model responds to `admin?` but this is not built into HyperMesh.
+In the below examples we assume that your user model responds to `admin?` but this is not built into Hyperloop.
 
 ```ruby
 class TodoPolicy
@@ -464,7 +472,7 @@ Note that there is no `allow_read` method.  Read access is granted if this brows
 
 #### Method Summary and Name Space Conflicts
 
-Policy classes (and the HyperMesh::PolicyMethods module) define the following class methods:
+Policy classes (and the Hyperloop::PolicyMethods module) define the following class methods:
 
 + `regulate_connection`
 + `regulate_all_broadcasts`
@@ -476,7 +484,9 @@ As well as the following instance methods:
 + `send_only`
 + `obj`
 
-To avoid name space conflicts with your classes, synchromesh policy classes (and the HyperMesh::PolicyMethods module) maintain class and instance `attr_accessor`s named `synchromesh_internal_policy_object`.   The above methods call methods of the same name in the appropriate internal policy object.
+TODO check `synchromesh_internal_policy_object` new name
+
+To avoid name space conflicts with your classes, Hyperloop policy classes (and the Hyperloop::PolicyMethods module) maintain class and instance `attr_accessor`s named `synchromesh_internal_policy_object`.   The above methods call methods of the same name in the appropriate internal policy object.
 
 You may thus freely redefine of the class and instance methods if you have name space conflicts
 

data/docs/client_side_scoping.md

@@ -1,14 +1,14 @@
 ## ActiveRecord Scope Enhancement
 
-When the client receives notification that a record has changed HyperMesh finds the set of currently rendered scopes that might be effected, and requests them to be updated from the server.  
+When the client receives notification that a record has changed Hyperloop finds the set of currently rendered scopes that might be effected, and requests them to be updated from the server.  
 
-On the server scopes are a useful way to structure code.  **On the client** scopes are vital as they limit the amount of data loaded, viewed, and updated in the browser.  Consider a factory floor management system that shows *job* state as work flows through the factory.  There may be millions of jobs that a production floor browser is authorized to view, but at any time there are probably only 50 being shown.  Using ActiveRecord scopes is the way HyperMesh keeps the data requested by the browser limited to a reasonable amount.  
+On the server scopes are a useful way to structure code.  **On the client** scopes are vital as they limit the amount of data loaded, viewed, and updated in the browser.  Consider a factory floor management system that shows *job* state as work flows through the factory.  There may be millions of jobs that a production floor browser is authorized to view, but at any time there are probably only 50 being shown.  Using ActiveRecord scopes is the way Hyperloop keeps the data requested by the browser limited to a reasonable amount.  
 
-To make scopes work efficiently on the client HyperMesh adds some features to the ActiveRecord `scope` and `default_scope` macros.  Note you must use the `scope` macro (and not class methods) for things to work with HyperMesh.
+To make scopes work efficiently on the client Hyperloop adds some features to the ActiveRecord `scope` and `default_scope` macros.  Note you must use the `scope` macro (and not class methods) for things to work with Hyperloop.
 
 The additional features are accessed via the `:joins`, `:client`, and `:select` options.
 
-The `:joins` option tells the HyperMesh client which models are joined with the scope.  *You must add a `:joins` option if the scope has any data base join operations in it, otherwise if a joined model changes, HyperMesh will not know to update the scope.*
+The `:joins` option tells the Hyperloop client which models are joined with the scope.  *You must add a `:joins` option if the scope has any data base join operations in it, otherwise if a joined model changes, Hyperloop will not know to update the scope.*
 
 The `:client` and `:select` options provide the client a way to update scopes without having to contact the server.  Unlike the `:joins` option this is an optimization and is not required for scopes to work.
 
@@ -34,7 +34,7 @@ class Todo < ActiveRecord::Base
   # Now with_recent_comments will be re-evaluated whenever a Todo record, or a Comment
   # joined with a Todo change.
 
-  # Normally whenever HyperMesh detects that a scope may be effected by a changed
+  # Normally whenever Hyperloop detects that a scope may be effected by a changed
   # model, it will request the scope be re-evaluated on the server.  To offload this
   # computation to the client provide a client side scope method:
 

data/docs/configuration_details.md

@@ -1,39 +1,20 @@
-# HyperMesh Configuration
+# Hyperloop Configuration
 
+TODO will this be replaced by readme from hyper-configuration gem?
 
-# ![](/work-in-progress-drinking.png) WARNING DOCS AND EXAMPLES ARE BEING REWRITTEN  MANY LINKS MAY BE BROKEN  STAY TUNED OR CHECK IN AT [![Join the chat at https://gitter.im/reactrb/chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/reactrb/chat?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) FOR MORE INFO 
-
-There are XXX parts to the HyperMesh configuration:
+There are parts to the Hyperloop configuration:
 
 1. Model classes
 2. Policies
 3. Push Transport
 
-## Installation
-
-If you do not already have hyper-react installed, then use the reactrb-rails-generator gem to setup hyper-react, reactive-record and associated gems.
-
-Then add this line to your application's Gemfile:
-
-```ruby
-gem 'HyperMesh'
-```
-
-And then execute:
-
-    $ bundle install
-
-Also you must `require 'hyper-tracemesh'` from your client side code.  The easiest way is to
-find the `require 'reactive-record'` line (typically in `components.rb`) and replace it with
- `require 'HyperMesh'`.  
-
 ## Configuration
 
 Add an initializer like this:
 
 ```ruby
-# for rails this would go in: config/initializers/HyperMesh.rb
-HyperMesh.configuration do |config|
+# for rails this would go in: config/initializers/Hyperloop.rb
+Hyperloop.configuration do |config|
   config.transport = :simple_poller # or :none, action_cable, :pusher - see below)
 end
 # for a minimal setup you will need to define at least one channel, which you can do
@@ -47,27 +28,6 @@ class ApplicationPolicy
 end
 ```
 
-Assuming you are up and running with Hyper-React on Rails:
-
-1. **Add the gem**  
-add `gem 'hyper-mesh'`, and bundle install
-6. **Add the models directory to asset path**   
-```ruby
-# application.rb
-    config.assets.paths << ::Rails.root.join('app', 'models').to_s
-```
-
-2. **Require HyperMesh instead of HyperReact**  
-replace `require 'hyper-react'` with `require 'hyper-mesh'` in the components manifest (`app/views/components.rb`.)
-3. **Require your models on the client_side_scoping**  
-add `require 'models'` to the bottom of the components manifest
-4. add a models manifest in the models directory:  
-```ruby
-# app/models/models.rb
-require_tree './public'
-```
-5. create a `public` directory in your models directory and move any models that you want access to on the client into this directory.  Access to these models will be protected by *Policies* you will be creating later.
-
-A minimal HyperMesh configuration consists of a simple initializer file, and at least one *Policy* class that will *authorize* who gets to see what.
+A minimal Hyperloop configuration consists of a simple initializer file, and at least one *Policy* class that will *authorize* who gets to see what.
 
 The initializer file specifies what transport will be used.  Currently you can use [Pusher](http://pusher.com), ActionCable (if using Rails 5), Pusher-Fake (for development) or a Simple Poller for testing etc.

data/docs/pusher_faker_quickstart.md

@@ -7,7 +7,7 @@ The [Pusher-Fake](https://github.com/tristandunn/pusher-fake) gem will provide a
 - add `gem 'pusher'` to your Gemfile.
 - add `gem 'pusher-fake'` to the development and test sections of your Gemfile.
 
-If you have not already installed the `hyper-react` and `hyper-mesh` gems, then do so now using the [hyper-rails](https://github.com/ruby-hyperloop/hyper-rails) gem.
+If you have not already installed the `hyper-component` and `hyper-model` gems, then do so now using the [hyper-rails](https://github.com/ruby-hyperloop/hyper-rails) gem.
 
 - add `gem 'hyper-rails'` to your gem file (in the development section)
 - run `bundle install`
@@ -19,16 +19,16 @@ If you have not already installed the `hyper-react` and `hyper-mesh` gems, then
 ```ruby
 # app/assets/javascript/application.js
 ...
-//= require 'hyper-mesh/pusher'
+//= require 'hyper-model/pusher'
 //= require_tree .
 Opal.load('components');
 ```
 
 #### 3 Set the transport
 
-Once you have HyperMesh, and pusher installed then add this initializer:
+Once you have Hyperloop, and pusher installed then add this initializer:
 ```ruby
-# typically app/config/initializers/HyperMesh.rb
+# typically app/config/initializers/Hyperloop.rb
 # or you can do a similar setup in your tests (see this gem's specs)
 require 'pusher'
 require 'pusher-fake'
@@ -40,9 +40,9 @@ Pusher.secret = "MY_TEST_SECRET"
 # The next line actually starts the pusher-fake server (see the Pusher-Fake readme for details.)
 require 'pusher-fake/support/base' # if using pusher with rspec change this to pusher-fake/support/rspec
 # now copy over the credentials, and merge with PusherFake's config details
-HyperMesh.configuration do |config|
+Hyperloop.configuration do |config|
   config.transport = :pusher
-  config.channel_prefix = "HyperMesh"
+  config.channel_prefix = "Hyperloop"
   config.opts = {
     app_id: Pusher.app_id,
     key: Pusher.key,
@@ -53,65 +53,4 @@ end
 
 #### 4 Try It Out  
 
-If you don't already have a model to play with,  add one now:
-
-`bundle exec rails generate model Word text:string`
-
-`bundle exec rake db:migrate`
-
-Move `app/models/word.rb` to `app/models/public/word.rb`
-
-**Leave** `app/models/model.rb` where it is.  This is your models client side manifest file.
-
-Whatever model(s) you will plan to access on the client need to moved to the `app/models/public` directory.  This allows reactive-record to build a client side proxy for the models.  Models not moved will be completely invisible on the client side.
-
-**Important** in rails 5 there is also a base `ApplicationRecord` class, that all other models are built from.  This class must be moved to the public directory as well.
-
-If you don't already have a component to play with,  here is a simple one (make sure you added the Word model):
-
-```ruby
-# app/views/components/app.rb
-class App < React::Component::Base
-
-  def add_new_word
-    # for fun we will use setgetgo.com to get random words!
-    HTTP.get("http://randomword.setgetgo.com/get.php", dataType: :jsonp) do |response|
-      Word.new(text: response.json[:Word]).save
-    end
-  end
-
-  render(DIV) do
-    SPAN { "Count of Words: #{Word.count}" }
-    BUTTON { "add another" }.on(:click) { add_new_word }
-    UL do
-      Word.each { |word| LI { word.text } }
-    end
-  end
-end
-```
-
-Add a controller:
-
-```ruby
-#app/controllers/test_controller.rb
-class TestController < ApplicationController
-  def app
-    render_component
-  end
-end
-```
-
-Add the `test` route to your routes file:
-
-```ruby
-#app/config/routes.rb
-
-  get 'test', to: 'test#app'
-
-```
-
-Fire up rails with `bundle exec rails s` and open your app in a couple of browsers.  As data changes you should see them all updating together.
-
-You can also fire up a rails console, and then for example do a `Word.new(text: "Hello").save` and again see any browsers updating.
-
-If you want to go into more details with the example check out [words-example](/docs/words-example.md)
+TODO include try_it_out partial