Skip to content
This repository was archived by the owner on Oct 19, 2018. It is now read-only.

Commit 0068859

Browse files
committedOct 30, 2016
README update [skip ci]
1 parent 0dcba57 commit 0068859

File tree

2 files changed

+36
-32
lines changed

2 files changed

+36
-32
lines changed
 

‎README.md

+12-32
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
1-
# Reactrb
1+
# hyper-react
22

33
[![Join the chat at https://gitter.im/reactrb/chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/reactrb/chat?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
44
[![Build Status](https://travis-ci.org/reactrb/reactrb.svg?branch=master)](https://travis-ci.org/reactrb/reactrb)
55
[![Code Climate](https://codeclimate.com/github/reactrb/reactrb/badges/gpa.svg)](https://codeclimate.com/github/reactrb/reactrb)
66
[![Gem Version](https://badge.fury.io/rb/reactrb.svg)](https://badge.fury.io/rb/reactrb)
77

8-
**Reactrb is an [Opal Ruby](http://opalrb.org) wrapper of
9-
[React.js library](http://facebook.github.io/reactrb/)**.
8+
**hyper-react is an [Opal Ruby](http://opalrb.org) wrapper of
9+
[React.js library](https://facebook.github.io/react)**.
1010

1111
It lets you write reactive UI components, with Ruby's elegance using the tried
1212
and true React.js engine. :heart:
1313

1414
Visit [** ruby-hyperloop.io**](http://ruby-hyperloop.io) for the full story.
1515

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.
1717

1818
## Installation
1919

2020
Install the gem, or load the js library
2121

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`
2424
3. Or install (or load via cdn) from [reactrb-express.js](http://github.com/reactrb/reactrb-express)
2525

2626
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
6666
end
6767
```
6868

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.
7070

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.
7272

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.
7474

7575

7676
## Why ?
@@ -89,29 +89,9 @@ Under the hood the actual work is effeciently done by the [React.js](http://face
8989
+ [Github Issues](https://github.com/reactrb/reactrb/issues) for bugs, feature enhancements, etc.
9090

9191

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-
11092
## Roadmap
11193

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`).
11595

11696
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.
11797

@@ -132,10 +112,10 @@ Note that these are very simple examples, for the purpose of showing how to conf
132112
## Contributions
133113

134114
This project is still in early stage, so discussion, bug reports and PRs are
135-
really welcome :wink:.
115+
really welcome :wink:.
136116

137117

138118
## License
139119

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
141121
more info.

‎UPGRADING.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
## Upgrading to hyper-react from Reactrb
2+
3+
Follow these steps to upgrade:
4+
5+
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

Comments
 (0)
This repository has been archived.