Skip to content

Commit a5e60ce

Browse files
committed
Updated README with info about react-rails and React versions, fixes #35
1 parent 193f08b commit a5e60ce

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# react-rails [![Build Status](https://travis-ci.org/reactjs/react-rails.png)](https://travis-ci.org/reactjs/react-rails) [![Code Climate](https://codeclimate.com/github/reactjs/react-rails.png)](https://codeclimate.com/github/reactjs/react-rails)
22

3+
**react-rails version discaimer**
4+
*This README is for `1.x` branch which is still in development. Please switch to latest `0.x` branch for stable version.*
5+
6+
*Additionaly: `0.x` branch directly follows React versions, `1.x` will not do so.*
7+
38
react-rails is a ruby gem which makes it easier to use [React](http://facebook.github.io/react/) and [JSX](http://facebook.github.io/react/docs/jsx-in-depth.html) in your Ruby on Rails application.
49

510
This is done in 2 ways:
@@ -16,6 +21,8 @@ As with all gem dependencies, we strongly recommend adding `react-rails` to your
1621

1722
```ruby
1823
# Gemfile
24+
# If you missed a warning at the top of this README - this is still in development
25+
# which means this version is not pushed to rubygems.org
1926

2027
gem 'react-rails', '~> 1.0.0'
2128
```
@@ -131,6 +138,10 @@ end
131138

132139
In some cases you may want to have your `react.js` and `JSXTransformer.js` files come from a different release than the one, that is specified in the `react-rails.gemspec`. To achieve that, you have to manually replace them in your app.
133140

141+
react-rails at `0.x` requires React at `0.4+`, or `0.5+` or even higher if you need certain add-ons.
142+
143+
react-rails at `1.x` requires React at `0.9+`.
144+
134145
#### Instructions
135146

136147
Just put another version of `react.js` or `JSXTransformer.js` under `/vendor/assets/react` directory.

0 commit comments

Comments
 (0)