Skip to content

Commit e3cb798

Browse files
committed
readme fixes
1 parent e71e73a commit e3cb798

File tree

1 file changed

+14
-29
lines changed

1 file changed

+14
-29
lines changed

README.md

Lines changed: 14 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,35 @@
11
[![Specs](https://github.com/matestack/matestack-ui-bootstrap/workflows/specs/badge.svg)](https://github.com/matestack/matestack-ui-bootstrap/actions)
22
[![Discord](https://img.shields.io/discord/771413294136426496.svg)](https://discord.com/invite/c6tQxFG)
3-
[![Gem Version](https://badge.fury.io/rb/matestack-ui-core.svg)](https://badge.fury.io/rb/matestack-ui-core)
4-
[![Docs](https://img.shields.io/badge/docs-matestack-blue.svg)](https://docs.matestack.io)
3+
[![Gem Version](https://badge.fury.io/rb/matestack-ui-bootstrap.svg)](https://badge.fury.io/rb/matestack-ui-bootstrap)
4+
[![Docs](https://img.shields.io/badge/docs-matestack-blue.svg)](https://docs.matestack.io/matestack-ui-bootstrap)
55
[![Twitter Follow](https://img.shields.io/twitter/follow/matestack.svg?style=social)](https://twitter.com/matestack)
66

77
![matestack logo](./logo.png)
88

9-
# matestack-ui-bootstrap | beautiful UIs in pure Ruby
9+
# matestack-ui-bootstrap | beautiful, reactive UIs in pure Ruby
1010

1111
As an extension for [`matestack-ui-core`](https://github.com/matestack/matestack-ui-core), `matestack-ui-bootstrap` ships all you need to build beautiful,
1212
reactive UIs in pure Ruby and smart CRUD components based on Bootstrap v5.
1313

14+
----
15+
1416
`matestack-ui-core` enables you to craft maintainable web UIs in pure Ruby, skipping ERB and HTML. UI code becomes a native and fun part of your Rails app. Thanks to reactive core components, reactivity can be optionally added on top without writing JavaScript, just using a simple Ruby DSL.
1517

1618
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.
1719

18-
`matestack-ui-core` does not have an opinion on styling
19-
Don't think about styling anymore and just create admin or application UIs faster than ever before!
20-
21-
[<img src="https://img.youtube.com/vi/bwsVgCb97v0/0.jpg" width="350">](https://www.youtube.com/watch?v=bwsVgCb97v0)
20+
----
2221

23-
The main goals are:
22+
`matestack-ui-core` does not have an opinion on styling. In contrast, `matestack-ui-bootstap` ships all Bootstrap v5 components as Matestack UI components usable in pure Ruby. Additionally layout and CRUD components help you to build a beautiful web app meeting typical requirements of a data driven web app.
2423

25-
- More maintainable UI code, using a component-based structure written in Ruby
26-
- Increased development speed and happiness, offering prebuilt UI-Components for typical requirements
27-
- Modern, dynamic UI feeling without the need to implement a separate JavaScript Application
24+
Don't think about styling anymore and just create admin or application UIs faster than ever before!
2825

29-
`matestack-ui-core` can progressively replace the classic Rails-View-Layer. You are able to use
30-
it alongside your classic views and incrementally turn your Rails-App into a
31-
dynamic Web-App.
26+
[<img src="https://img.youtube.com/vi/bwsVgCb97v0/0.jpg" width="350">](https://www.youtube.com/watch?v=bwsVgCb97v0)
3227

3328
## Compatibility
3429

3530
### Ruby/Rails
3631

37-
`matestack-ui-core` is tested against:
32+
`matestack-ui-bootstrap` is tested against:
3833

3934
- Rails 6.1.1 + Ruby 3.0.0
4035
- Rails 6.1.1 + Ruby 2.7.2
@@ -45,7 +40,7 @@ Rails versions below 5.2 are not supported.
4540

4641
### Vue.js
4742

48-
`matestack-ui-core` optionally requires Vue.js and Vuex for its reactivity features. Following version ranges are supported:
43+
`matestack-ui-core` requires Vue.js and Vuex for its reactivity features. Following version ranges are supported:
4944

5045
- Vue.js ^2.6.0
5146
- Vuex ^3.6.0
@@ -54,22 +49,12 @@ Vue 3 / Vuex 4 update is planned for Q2 2021.
5449

5550
## Documentation/Installation
5651

57-
Documentation can be found [here](https://docs.matestack.io)
58-
59-
## Getting started
60-
61-
A getting started guide can be found [here](https://docs.matestack.io/getting-started/tutorial)
52+
Documentation can be found [here](https://docs.matestack.io/matestack-ui-bootstap/)
6253

6354
## Changelog
6455

6556
Changelog can be found [here](./CHANGELOG.md)
6657

67-
## Community
68-
69-
As a low-barrier feedback channel for our early users, we have set up a Discord server that can be found [here](https://discord.com/invite/c6tQxFG). You are very welcome to ask questions and send us feedback there!
70-
71-
## Contribution
72-
73-
We are happy to accept contributors of any kind! In order to make it as easy and fun as possible to contribute to `matestack-ui-core`, we would like to onboard contributors personally! Best way to become a contributor: Ping us on Discord! We will schedule a video call with you and show you, how and what to work on :)
58+
## License
7459

75-
Here are some good first issues for first time contributors: [good first issues](https://github.com/matestack/matestack-ui-core/issues?q=is%3Aopen+is%3Aissue+label%3A"good+first+issue")
60+
`matestack-ui-bootstap` is an Open Source project licensed under the terms of the [MIT license](./LICENSE)

0 commit comments

Comments
 (0)