Skip to content

Commit 1d5fcd3

Browse files
committed
added compatibility infos and getting started guide video to readme
1 parent 03ae59c commit 1d5fcd3

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ Reactivity included if desired.
1515

1616
You end up writing 50% less code while increasing productivity, maintainability and developer happiness. Work with pure Ruby. If necessary, extend with pure JavaScript. No Opal involved.
1717

18+
[<img src="https://img.youtube.com/vi/Mue5gs6Wtq4/0.jpg" width="350">](https://www.youtube.com/watch?v=Mue5gs6Wtq4)
19+
1820
The main goals are:
1921

2022
- More maintainable UI code, using a component-based structure written in Ruby
@@ -25,6 +27,26 @@ The main goals are:
2527
it alongside your classic views and incrementally turn your Rails-App into a
2628
dynamic Web-App.
2729

30+
## Compatibility
31+
32+
### Ruby/Rails
33+
34+
`matestack-ui-core` is tested against:
35+
36+
- Rails 6.1.1 + Ruby 3.0.0
37+
- Rails 6.1.1 + Ruby 2.7.2
38+
- Rails 6.0.3.4 + Ruby 2.6.6
39+
- Rails 5.2.4.1 + Ruby 2.6.6
40+
41+
Rails versions below 5.2 are not supported.
42+
43+
### Vue.js
44+
45+
`matestack-ui-core` currently uses Vue.js 2.6.12 and Vuex 3.6.2 for its reactivity features.
46+
Custom reactive components are bound to these versions as well.
47+
48+
Vue 3 / Vuex 4 update is planned for Q2 2021.
49+
2850
## Documentation/Installation
2951

3052
Documentation can be found [here](https://docs.matestack.io)

0 commit comments

Comments
 (0)