Skip to content

Commit 9f9dada

Browse files
authored
Create README.md
1 parent f86127c commit 9f9dada

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

docs/README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Matestack UI Core Docs
2+
3+
Welcome to the docs of the Ruby gem `matestack-ui-core`!
4+
5+
Matestack 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.
6+
7+
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.
8+
9+
The docs cover following main topics:
10+
11+
**[Installation](/docs/start/100-installation/)**
12+
13+
Learn how to properly set up and update matestack-ui-core with your existing Rails application.
14+
15+
**[UI components in pure Ruby](/docs/ui_components/README.md)**
16+
17+
Craft your UI based on your components written in pure Ruby. Utilizing Ruby's amazing language features, you're able to create a cleaner and more maintainable UI implementation.
18+
19+
**[Reactive components in pure Ruby](/docs/reactive_components/README.md)**
20+
21+
*Optional feature*
22+
23+
What about going even one step further and implement **REACTIVE** UIs in pure Ruby? Matestack's reactive core components can be used with a simple Ruby DSL enabling you to create reactive UIs without touching JavaScript!
24+
25+
**[Reactive apps in pure Ruby](/docs/reactive_apps/README.md)**
26+
27+
*Optional feature*
28+
29+
The last step in order to leverage the full Matestack power: Create app (~Rails layout) and page (Rails ~view) classes and implement dynamic page transitions without any JavaScript implementation required.
30+
31+
In order to get started quickly, you might want to start with the [getting-started-guide](/docs/start/150-getting_started)

0 commit comments

Comments
 (0)