adjusted readme

Author: jonasjabari

README.md

@@ -1,84 +1,75 @@
-# Matestack Ui Bootstrap
+[![Specs](https://github.com/matestack/matestack-ui-bootstrap/workflows/specs/badge.svg)](https://github.com/matestack/matestack-ui-bootstrap/actions)
+[![Discord](https://img.shields.io/discord/771413294136426496.svg)](https://discord.com/invite/c6tQxFG)
+[![Gem Version](https://badge.fury.io/rb/matestack-ui-core.svg)](https://badge.fury.io/rb/matestack-ui-core)
+[![Docs](https://img.shields.io/badge/docs-matestack-blue.svg)](https://docs.matestack.io)
+[![Twitter Follow](https://img.shields.io/twitter/follow/matestack.svg?style=social)](https://twitter.com/matestack)
 
-**Docs and specs in progress, please wait for official release announcement before using this gem**
+![matestack logo](./logo.png)
 
-## Development
+# matestack-ui-bootstrap | beautiful UIs in pure Ruby
 
-### Dummy App
+As an extension for [`matestack-ui-core`](https://github.com/matestack/matestack-ui-core), `matestack-ui-bootstrap` ships all you need to build beautiful,
+reactive UIs in pure Ruby and smart CRUD components based on Bootstrap v5.
 
-**initial setup**
+`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.
 
-```shell
-docker-compose build dummy
-docker-compose run --rm dummy bash
-```
+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.
 
-inside container:
+`matestack-ui-core` does not have an opinion on styling
+Don't think about styling anymore and just create admin or application UIs faster than ever before!
 
-```shell
-bundle install
-yarn install
-cd spec/dummy
-bundle install
-npm install (npm and not yarn!)
-rails app:db:setup
-```
+[<img src="https://img.youtube.com/vi/bwsVgCb97v0/0.jpg" width="350">](https://www.youtube.com/watch?v=bwsVgCb97v0)
 
-**dummy app start**
+The main goals are:
 
-on your host:
-```shell
-docker-compose up dummy
-```
+- More maintainable UI code, using a component-based structure written in Ruby
+- Increased development speed and happiness, offering prebuilt UI-Components for typical requirements
+- Modern, dynamic UI feeling without the need to implement a separate JavaScript Application
 
-and
+`matestack-ui-core` can progressively replace the classic Rails-View-Layer. You are able to use
+it alongside your classic views and incrementally turn your Rails-App into a
+dynamic Web-App.
 
-```shell
-docker-compose run --rm dummy sh -c "cd spec/dummy && ./bin/webpack --watch"
-```
+## Compatibility
 
-simultaneously to be able to visit the demo app on [localhost:3000](localhost:3000).
+### Ruby/Rails
 
-## Testing
+`matestack-ui-core` is tested against:
 
-**initial setup**
+- Rails 6.1.1 + Ruby 3.0.0
+- Rails 6.1.1 + Ruby 2.7.2
+- Rails 6.0.3.4 + Ruby 2.6.6
+- Rails 5.2.4.4 + Ruby 2.6.6
 
-```shell
-docker-compose build dummy
-docker-compose run --rm dummy bash
-```
+Rails versions below 5.2 are not supported.
 
-inside container:
+### Vue.js
 
-```shell
-bundle install
-yarn install
-cd spec/dummy
-bundle install
-npm install (npm and not yarn!)
-rails app:db:setup
-```
+`matestack-ui-core` optionally requires Vue.js and Vuex for its reactivity features. Following version ranges are supported:
 
-**test run**
+- Vue.js ^2.6.0
+- Vuex ^3.6.0
 
-```shell
-docker-compose run --rm builder bash
+Vue 3 / Vuex 4 update is planned for Q2 2021.
 
-```
+## Documentation/Installation
 
-inside container:
+Documentation can be found [here](https://docs.matestack.io)
 
-```shell
-bundle exec rspec spec/test
-```
+## Getting started
 
-## Release
+A getting started guide can be found [here](https://docs.matestack.io/getting-started/tutorial)
 
-```shell
-docker-compose run --rm builder
-gem bump ...
-gem release
-npm bump ...
-npm release
-git tag ...
-```
+## Changelog
+
+Changelog can be found [here](./CHANGELOG.md)
+
+## Community
+
+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!
+
+## Contribution
+
+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 :)
+
+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")