@@ -23,34 +23,36 @@ Gem::Specification.new do |spec|
2323
2424Welcome to Hyperstack!
2525
26- For a complete install run
26+ For a quick start simply add a component using one of the generators:
2727
28- bundle exec rails hyperstack:install
28+ >> bundle exec rails generate hyper:component CompName --add-route=/test/(*others)
29+ # Add a new component named CompName and route to it with /test/
2930
30- You can also add components directly using generators:
31-
32- bundle exec rails generate hyper:component CompName --add-route=/test/(*others)
33- # Add a new component named CompName and route to it with /test/
34-
35- bundle exec rails generate hyper:router CompName --add-route=/test/(*others)
36- # Add a top level router named CompName
37- bundle exec rails
31+ >> bundle exec rails generate hyper:router CompName --add-route=/test/(*others)
32+ # Add a top level router named CompName
3833
3934The generators will insure you have the minimal additions to your system for the
4035new component to run. And note: --add-route is optional.
4136
42- The hyperstack:install task also has options to control how much of the `Stack
43- gets installed:
37+ For a complete install run the hyperstack install task:
38+
39+ >> bundle exec rails hyperstack:install
40+
41+ This will add everything you need including the hotloader, webpack integration,
42+ hyper-model (active record model client synchronization) and a top level
43+ component to get you started.
44+
45+ You can control how much of the stack gets installed using these options:
4446
45- --skip-hotloader # don't add the hotloader
46- --skip-webpack # don't add webpack
47- --skip-hyper-model # don't add hyper-model and default policy files
47+ --skip-hotloader # don't add the hotloader
48+ --skip-webpack # don't add webpack
49+ --skip-hyper-model # don't add hyper-model and default policy files
4850
4951You can always install these pieces later using these options:
5052
51- --hotloader-only # just add the hotloader
52- --webpack-only # just add webpack
53- --hyper-model-only # just add hyper-model, and default policy files
53+ --hotloader-only # just add the hotloader
54+ --webpack-only # just add webpack
55+ --hyper-model-only # just add hyper-model, and default policy files
5456
5557*******************************************************************************
5658}
0 commit comments