You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Oct 19, 2018. It is now read-only.
Copy file name to clipboardexpand all lines: README.md
+12-32
Original file line number
Diff line number
Diff line change
@@ -1,26 +1,26 @@
1
-
# Reactrb
1
+
# hyper-react
2
2
3
3
[](https://gitter.im/reactrb/chat?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
It lets you write reactive UI components, with Ruby's elegance using the tried
12
12
and true React.js engine. :heart:
13
13
14
14
Visit [** ruby-hyperloop.io**](http://ruby-hyperloop.io) for the full story.
15
15
16
-
### Important: `react.rb` and `reactive-ruby` gems are **deprecated.** Please [read this!](#upgrading-to-reactrb)
16
+
### Important: `react.rb`, `reactive-ruby`and `reactrb`gems are **deprecated.**. See [**UPGRADING**](UPGRADING.md) for details.
17
17
18
18
## Installation
19
19
20
20
Install the gem, or load the js library
21
21
22
-
1. Add `gem 'reactrb'` to your **Gemfile**
23
-
2. Or `gem install reactrb`
22
+
1. Add `gem 'hyper-react'` to your **Gemfile**
23
+
2. Or `gem install hyper-react`
24
24
3. Or install (or load via cdn) from [reactrb-express.js](http://github.com/reactrb/reactrb-express)
25
25
26
26
For gem installation it is highly recommended to read the [getting started](http://ruby-hyperloop.io/get_started/) and [installation](http://ruby-hyperloop.io/installation/) guides at [ruby-hyperloop.io.](http://ruby-hyperloop.io)
@@ -66,11 +66,11 @@ every(1) do
66
66
end
67
67
```
68
68
69
-
Reactrb components are *isomorphic* (or *univeral*) meaning they can run on the server as well as the client.
69
+
hyper-react components are *isomorphic* (or *univeral*) meaning they can run on the server as well as the client.
70
70
71
-
Reactrb integrates well with Rails, Sinatra, and simple static sites, and can be added to existing web pages very easily.
71
+
hyper-react integrates well with Rails, Sinatra, and simple static sites, and can be added to existing web pages very easily.
72
72
73
-
Under the hood the actual work is effeciently done by the [React.js](http://facebook.github.io/reactrb/) engine.
73
+
Under the hood the actual work is effeciently done by the [React.js](https://facebook.github.io/react) engine.
74
74
75
75
76
76
## Why ?
@@ -89,29 +89,9 @@ Under the hood the actual work is effeciently done by the [React.js](http://face
89
89
+[Github Issues](https://github.com/reactrb/reactrb/issues) for bugs, feature enhancements, etc.
90
90
91
91
92
-
## Upgrading to Reactrb
93
-
94
-
The original gem `react.rb` was superceeded by `reactive-ruby`, which has had over 15,000 downloads. This name has now been superceeded by `reactrb` (see #144 for detailed discussion on why.)
95
-
96
-
Going forward the name `reactrb` will be used consistently as the organization name, the gem name, the domain name, the twitter handle, etc.
97
-
98
-
The first initial version of `reactrb` is 0.8.x.
99
-
100
-
It is very unlikely that there will be any more releases of the `reactive-ruby` gem, so users should upgrade to `reactrb`.
101
-
102
-
There are no syntactic or semantic breaking changes between `reactrb` v 0.8.x and
103
-
previous versions, however the `reactrb` gem does *not* include the react-js source as previous versions did. This allows you to pick the react js source compatible with other gems and react js components you may be using.
104
-
105
-
Follow these steps to upgrade:
106
-
107
-
1. Replace `reactive-ruby` with `reactrb` both in **Gemfile** and any `require`s in your code.
108
-
2. To include the React.js source, the suggested way is to add `require 'react/react-source'` before `require 'reactrb'`. This will use the copy of React.js source from `react-rails` gem.
109
-
110
92
## Roadmap
111
93
112
-
Upcoming will be an 0.9.x release which will deprecate a number of features and DSL elements. [click for detailed feature list](https://github.com/reactrb/reactrb/milestones/0.9.x)
113
-
114
-
Version 0.10.x **will not be** 100% backward compatible with 0.3.0 (`react.rb`) or 0.7.x (`reactive-ruby`) so its very important to begin your upgrade process now by switching to `reactrb` now.
94
+
Version 0.10.x **will not be** 100% backward compatible with 0.3.0 (`react.rb`) or 0.7.x (`reactive-ruby`).
115
95
116
96
Please let us know either at [Gitter.im](https://gitter.im/reactrb/chat) or [via an issue](https://github.com/reactrb/reactrb/issues) if you have specific concerns with the upgrade from 0.3.0 to 0.10.x.
117
97
@@ -132,10 +112,10 @@ Note that these are very simple examples, for the purpose of showing how to conf
132
112
## Contributions
133
113
134
114
This project is still in early stage, so discussion, bug reports and PRs are
135
-
really welcome :wink:.
115
+
really welcome :wink:.
136
116
137
117
138
118
## License
139
119
140
-
In short, Reactrb is available under the MIT license. See the LICENSE file for
120
+
In short, hyper-react is available under the MIT license. See the LICENSE file for
1. Replace `reactrb` with `hyper-react` both in **Gemfile** and any `require`s in your code.
6
+
2. To include the React.js source, the suggested way is to add `require 'react/react-source'` before `require 'hyper-react'`. This will use the copy of React.js source from `react-rails` gem.
7
+
8
+
## Upgrading to Reactrb
9
+
10
+
The original gem `react.rb` was superceeded by `reactive-ruby`, which has had over 15,000 downloads. This name has now been superceeded by `reactrb` (see #144 for detailed discussion on why.)
11
+
12
+
Going forward the name `reactrb` will be used consistently as the organization name, the gem name, the domain name, the twitter handle, etc.
13
+
14
+
The first initial version of `reactrb` is 0.8.x.
15
+
16
+
It is very unlikely that there will be any more releases of the `reactive-ruby` gem, so users should upgrade to `reactrb`.
17
+
18
+
There are no syntactic or semantic breaking changes between `reactrb` v 0.8.x and
19
+
previous versions, however the `reactrb` gem does *not* include the react-js source as previous versions did. This allows you to pick the react js source compatible with other gems and react js components you may be using.
20
+
21
+
Follow these steps to upgrade:
22
+
23
+
1. Replace `reactive-ruby` with `reactrb` both in **Gemfile** and any `require`s in your code.
24
+
2. To include the React.js source, the suggested way is to add `require 'react/react-source'` before `require 'reactrb'`. This will use the copy of React.js source from `react-rails` gem.
0 commit comments