Merge pull request #228 from rmosolgo/react-versioning

feat(versions) add VERSIONS.md for gem/React versions

Author: Robert Mosolgo

README.md

@@ -78,7 +78,7 @@ end
 
 After restarting your Rails server, `//= require react`  will provide the build of React.js which was specified by the configurations.
 
-In a pinch, you can also provide your own copies of React.js and JSXTransformer. Just add `react.js` or `JSXTransformer.js` (case-sensitive) files to `app/vendor/assets/javascripts/react/` and restart your development server. If you need different versions of React in different environments, put them in directories that match `config.react.variant`. For example, if you set `config.react.variant = :development`, you could put a copy of `react.js` in `/vendor/assets/react/development/`.
+`react-rails` offers a few other options for versions & builds of React.js. See [VERSIONS.md](https://github.com/reactjs/react-rails/blob/master/VERSIONS.md) for more info about using the `react-source` gem or dropping in your own copies of React.js.
 
 ### JSX
 

VERSIONS.md

@@ -0,0 +1,43 @@
+# Versions
+
+There are three ways to control what version of React.js (and JSXTransformer) is used by `react-rails`:
+
+- Use the [bundled version](#bundled-versions) that comes with the gem
+- Specify a [react-source verison](#react-source-version)
+- [Drop in a copy](#drop-in-version) of React.js
+
+## Bundled Versions
+
+| Gem      | React.js |
+|----------|----------|
+| master   | ~> 0.13  |
+| 0.13.0.0 | 0.13.0   |
+| 0.12.2.0 | 0.12.2   |
+| 0.12.1.0 | 0.12.1   |
+| 0.12.0.0 | 0.12.0   |
+
+
+## React-Source Version
+
+The [`react-source` gem](https://rubygems.org/gems/react-source) provides JS files to `react-rails`.
+
+You can specify a React.js version by locking to a specific `react-source` in your Gemfile. For example:
+
+```ruby
+gem 'react-rails'
+# always use React version 0.13.1:
+gem 'react-source', '0.13.1'
+```
+
+## Drop-in Version
+
+You can also provide your own copies of React.js and JSXTransformer. Just add `react.js` or `JSXTransformer.js` (case-sensitive) files in directories where `react-rails` expects to find them.
+
+To use the _same version in all environments_, put files in `app/vendor/assets/react/`.
+
+If you need _different versions in different environments_, put them in directories that match `config.react.variant`. For example, if you set `config.react.variant = :development`, you could put a copy of `react.js` in `app/vendor/assets/react/development/`.
+
+
+
+
+

lib/react/rails/version.rb

@@ -1,5 +1,6 @@
 module React
   module Rails
+    # If you change this, make sure to update VERSIONS.md
     VERSION = '1.0.0.pre'
   end
 end

react-rails.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'execjs'
   s.add_dependency 'coffee-script-source', '~>1.8'
   s.add_dependency 'rails', '>= 3.1'
+  # If you change this, make sure to update VERSIONS.md:
   s.add_dependency 'react-source', '~> 0.13'
   s.add_dependency 'connection_pool'