Skip to content

Commit fbebf84

Browse files
authored
Merge pull request #483 from matestack/refactor_installation_guide
Move link to interactive guide to bottom
2 parents 5dca762 + dfdb0e5 commit fbebf84

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

docs/start/100-installation/README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# Installation guide
22

3-
This guide shows you how to add matestack-ui-core to an existing rails application.
4-
5-
If you want to use Matestack's optional reactivity features, please follow this [guide](/docs/reactive_components/100-rails_integration/) after performed the following steps for basic installation:
3+
This guide shows you how to add the `matestack-ui-core` gem to an existing Rails application.
64

75
## Installation
86

@@ -20,12 +18,16 @@ $ bundle install
2018

2119
### Matestack folder
2220

23-
Create a folder called 'matestack' in your app directory. All your matestack apps,
21+
Create a folder called 'matestack' in your app directory. All your Matestack apps,
2422
pages and components will be defined there.
2523

24+
```shell
25+
$ mkdir app/matestack
26+
```
27+
2628
### Controller setup
2729

28-
Add the matestack helper to your controllers. If you want to make the helpers
30+
Add the Matestack helper to your controllers. If you want to make the helpers
2931
available in all controllers, add it to your 'ApplicationController' this way:
3032

3133
`app/controllers/application_controller.rb`
@@ -36,3 +38,9 @@ class ApplicationController < ActionController::Base
3638
#...
3739
end
3840
```
41+
42+
### Conclusion
43+
44+
Now, you are able to create UI components in pure Ruby and use them in your Rails views. Additionally you can substitute Rails views and layouts with Matestack pages and apps.
45+
46+
If you want to use Matestack's optional reactivity features in pure Ruby (through dynamic Vue.js components such as `form` and `async` or dynamic page transitions), please follow this [guide](/docs/reactive_components/100-rails_integration/) to set up the JavaScript parts via AssetPipeline or Webpacker.

0 commit comments

Comments
 (0)