react-rails 1.3.3 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b0add932e37ac43fea18b43d735f629beddd7fa
-  data.tar.gz: 23b384f84760fd7c3e6acaa544f8bba42225c681
+  metadata.gz: 59c0e2d224ae087eecda65188c20d2bfcff98e7b
+  data.tar.gz: e83257d235e950105dfc5a6367abcbcb56075508
 SHA512:
-  metadata.gz: 5f4838f09a9be35626d8e9dc0b3b0dda3154946a4734197f364f17c6ca2ab614030197360565cf735f6e7e150eeed37fa257237fcd4a98413d5529395c1695dc
-  data.tar.gz: a5df10dca7daa874f0afef8426e7f947d633b4ae248d684e2663ae33034142c6462b24600e7b84c9657625232c0b051d0f130d65308f35be94bb6a0e515a829d
+  metadata.gz: d9c0e1194927b94f6b618b2ffc33f41feb8d609f4468cba49f9d143a86b5b2ac7383a9109ea3ebc37e85e3a9ccd562b80bef87a024fee7a45ce2fcb32c4ba3f8
+  data.tar.gz: ffb97409f51d621879ebf3fad89bdcf3f0e972a63403b497ee12017e5665ad91a7729b2daa63d85ba94dbc82ae28e6bdae6bff68b9d2242b799a3ff76b150bb6

data/README.md

@@ -19,12 +19,14 @@ in your Ruby on Rails (3.2+) application. `react-rails` can:
 - [Generate components](#component-generator) with a Rails generator
 - [Be extended](#extending-react-rails) with custom renderers, transformers and view helpers
 
+Just getting started with React? Make sure to check out the [Getting Started] (https://facebook.github.io/react/docs/getting-started.html) guide.
+
 ## Installation
 
 Add `react-rails` to your gemfile:
 
 ```ruby
-gem 'react-rails', '~> 1.3.0'
+gem 'react-rails', '~> 1.4.0'
 ```
 
 Next, run the installation script:
@@ -194,7 +196,7 @@ MyApp::Application.configure do
   config.react.server_renderer_timeout    ||= 20 # seconds
   config.react.server_renderer = React::ServerRendering::SprocketsRenderer
   config.react.server_renderer_options = {
-    files: ["react.js", "components.js"], # files to load for prerendering
+    files: ["react-server.js", "components.js"], # files to load for prerendering
     replay_console: true,                 # if true, console.* will be replayed client-side
   }
 end
@@ -212,13 +214,14 @@ Components can also be prerendered directly from a controller action with the cu
 class TodoController < ApplicationController
   def index
     @todos = Todo.all
-    render component: 'TodoList', props: { todos: @todos }, tag: 'span'
+    render component: 'TodoList', props: { todos: @todos }, tag: 'span', class: 'todo'
   end
 end
 ```
 
 This custom renderer behaves the same as a normal view renderer and accepts the usual arguments - `content_type`, `layout`, `location` and `status`.
-By default, your current layout will be used and the component, rather than a view, will be rendered in place of `yield`.
+By default, your current layout will be used and the component, rather than a view, will be rendered in place of `yield`. Custom data-* attributes
+can be passed like `data: {remote: true}`.
 
 ### Component generator
 
@@ -268,6 +271,14 @@ For example:
 rails generate react:component Label label:string --es6
 ```
 
+**--coffee** : Generate the component using CoffeeScript syntax
+
+For example:
+
+```shell
+rails generate react:component Label label:string --coffee
+```
+
 #### Arguments
 
 The generator can use the following arguments to create basic propTypes:
@@ -323,6 +334,14 @@ Component = React.createClass
     `<ExampleComponent videos={this.props.videos} />`
 ```
 
+Alternatively, the newer ES6 style class based syntax can be used like this:
+
+```coffee
+class Component extends React.Component
+  render: ->
+    `<ExampleComponent videos={this.props.videos} />`
+```
+
 ## Extending `react-rails`
 
 You can extend some of the core functionality of `react-rails` by injecting new implementations during configuration.