bump version and readme updates

CHANGELOG.md

@@ -1,3 +1,6 @@
+## 3.4.1 (May 16 2016)
+* add backward compatibility for react-router@1 (https://github.com/paypal/react-engine/pull/159)
+
 ## 3.4.0 (May 13 2016)
 * Update deprecated `history` and `RoutingContext` for react-router (https://github.com/paypal/react-engine/pull/155)
 

README.md

@@ -70,8 +70,8 @@ app.set('view', require('react-engine/lib/expressView'));
 ```
 
 ###### Server options spec
-Pass in an optional JavaScript object as options to the react-engine's [server engine create method](#setup-in-an-express-app).
-The options object can contain properties from [react router's create configuration object](https://github.com/reactjs/react-router/blob/0.13.x/doc/02%20Top-Level/Router.create.md).
+Pass in a JavaScript object as options to the react-engine's [server engine create method](#setup-in-an-express-app).
+The options object should contain the mandatory `routes` property with the route definition.
 
 Additionally, it can contain the following **optional** properties,
 
@@ -126,10 +126,9 @@ var data = client.data();
 
 ###### Client options spec
 Pass in a JavaScript object as options to the react-engine's client boot function.
-The options object can contain properties from [react router's create configuration object](https://github.com/reactjs/react-router/blob/0.13.x/doc/02%20Top-Level/Router.create.md).
-
-Additionally, it can contain the following properties,
+It can contain the following properties,
 
+- `routes` : **required** - _Object_ - the route definition file.
 - `viewResolver` : **required** - _Function_ - a function that react-engine needs to resolve the view file.
  an example of the viewResolver can be [found here](https://github.com/paypal/react-engine/blob/ecd27b30a9028d3f02b8f8e89d355bb5fc909de9/examples/simple/public/index.js#L29).
 - `mountNode` : **optional** - _HTMLDOMNode_ - supply a HTML DOM Node to mount the server rendered component in the case of partial/non-full page rendering.
@@ -155,7 +154,7 @@ Note: By default, the following three keys are always filtered out from `renderO
 - `_locals`
 
 ### Handling redirects and route not found errors on the server side
-While using react-router, it matches the url to a component based on the app's defined routes. react-engine captures the redirects and not-found cases that are encountered while trying to run the react-router's [match function on the server side](https://github.com/react/react-router/blob/5590516ec228765cbb176c81fb15fe1d4662e475/docs/guides/advanced/ServerRendering.md).
+While using react-router, it matches the url to a component based on the app's defined routes. react-engine captures the redirects and not-found cases that are encountered while trying to run the react-router's [match function on the server side](https://github.com/reactjs/react-router/blob/master/docs/guides/ServerRendering.md).
 
 To handle the above during the lifecycle of a request, add an error type check in your express error middleware. The following are the three types of error that get thrown by react-engine:
 
@@ -227,7 +226,7 @@ var engine = require('react-engine').server.create({
 * [Blog on react-engine](https://www.paypal-engineering.com/2015/04/27/isomorphic-react-apps-with-react-engine/)
 
 ### Migration from 2.x to 3.x
-While upgrading to 3.x version of react-engine, make sure to follow the [react-router's 1.x upgrade guide](https://github.com/react/react-router/blob/5590516ec228765cbb176c81fb15fe1d4662e475/upgrade-guides/v1.0.0.md) to upgrade react-router related code in your app.
+While upgrading to 3.x version of react-engine, make sure to follow the [react-router's 2.x upgrade guide](https://github.com/reactjs/react-router/blob/master/upgrade-guides/v2.0.0.md) to upgrade react-router related code in your app.
 Then, add to your express error middleware, react-engine's MATCH_REDIRECT and MATCH_NOT_FOUND checks.
 
 ### Migration from 1.x to 2.x

example/public/views/404.jsx

@@ -16,7 +16,6 @@
 'use strict';
 
 var React = require('react');
-var Layout = require('./layout.jsx');
 
 module.exports = React.createClass({
  displayName: '404',

example/public/views/500.jsx

@@ -16,7 +16,6 @@
 'use strict';
 
 var React = require('react');
-var Layout = require('./layout.jsx');
 
 module.exports = React.createClass({
  displayName: '500',

package.json

@@ -1,6 +1,6 @@
 {
  "name": "react-engine",
- "version": "3.4.0",
+ "version": "3.4.1",
  "description": "a composite render engine for express apps to render both plain react views and react-router views",
  "main": "index.js",
  "scripts": {
@@ -62,7 +62,8 @@
  "Jared Halpert <jaredhalpert90@gmail.com>",
  "Weng Zhi Ping",
  "Vincent Orr <vincent@cmdv.org>",
- "skarflacka"
+ "skarflacka",
+ "Mark <mark@remarkablemark.org>"
  ],
  "licenses": [
  {