README.md in react-rails-0.4.1.1 vs README.md in react-rails-0.5.1.0
- old
+ new
@@ -1,6 +1,6 @@
-# react-rails [](https://travis-ci.org/facebook/react-rails)
+# react-rails [](https://travis-ci.org/facebook/react-rails) [](https://codeclimate.com/github/facebook/react-rails)
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.
This is done in 2 ways:
@@ -23,11 +23,11 @@
## Usage
### react.js
-In order to use React client-side in your application, you must make sure the browser requests it. One way to do that is to drop `react.js` into `app/assets/javascript/` and by default your applcation manifest will pick it up. There are downsides to this approach, so we made it even easier. Once you have `react-rails` installed, you can just require react directly in your manifest:
+In order to use React client-side in your application, you must make sure the browser requests it. One way to do that is to drop `react.js` into `app/assets/javascript/` and by default your applcation manifest will pick it up. There are downsides to this approach, so we made it even easier. Once you have `react-rails` installed, you can just add a line into your config file (see Configuring) and require react directly in your manifest:
You can `require` it in your manifest:
```js
// app/assets/application.js
@@ -49,10 +49,12 @@
To transform your JSX into JS, simply create `.js.jsx` files, and ensure that the file has the `/** @jsx React.DOM */` docblock. These files will be transformed on request, or precompiled as part of the `assets:precompile` task.
## Configuring
+### Variants
+
There are 2 variants available. `:development` gives you the unminified version of React. This provides extra debugging and error prevention. `:production` gives you the minified version of React which strips out comments and helpful warnings, and minifies.
```ruby
# config/environments/development.rb
MyApp::Application.configure do
@@ -63,6 +65,28 @@
MyApp::Application.configure do
config.react.variant = :production
end
```
+### Add-ons
+
+Beginning with React v0.5, there is another type of build. This build ships with some "add-ons" that might be useful - [take a look at the React documentation for details](http://facebook.github.io/react/docs/addons.html). In order to make these available, we've added another configuration (which defaults to `false`).
+
+```ruby
+MyApp::Application.configure do
+ config.react.addons = true
+end
+```
+
+
+## CoffeeScript
+
+It is possible to use JSX with CoffeeScript. The caveat is that you will still need to include the docblock. Since CoffeeScript doesn't allow `/* */` style comments, we need to do something a little different. We also need to embed JSX inside backticks so CoffeeScript ignores the syntax it doesn't understand. Here's an example:
+
+```coffee
+###* @jsx React.DOM ###
+
+Component = React.createClass
+ render: ->
+ `<ExampleComponent videos={this.props.videos} />`
+```