Merge pull request #156 from rackt/public-modules

[changed] location of public modules

Author: ryanflorence

ActiveState.js

@@ -0,0 +1 @@
+module.exports = require('./modules/mixins/ActiveState');

AsyncState.js

@@ -0,0 +1 @@
+module.exports = require('./modules/mixins/AsyncState');

Link.js

@@ -0,0 +1 @@
+module.exports = require('./modules/components/Link');

Route.js

@@ -0,0 +1 @@
+module.exports = require('./modules/components/Route');

Routes.js

@@ -0,0 +1 @@
+module.exports = require('./modules/components/Routes');

docs/api/README.md

@@ -16,3 +16,14 @@ React Router API
   - [`ActiveState`](/docs/api/mixins/ActiveState.md)
   - [`AsyncState`](/docs/api/mixins/AsyncState.md)
 
+
+Public Modules
+--------------
+
+All modules found at the repository root are considered public. You can
+require them conveniently with `var Route = require('react-router/Route');` etc.
+
+Note that we do not support requiring modules from our `modules`
+directory. (No notes in the changelog, no changes to the versioning of
+the lib, etc.)
+

docs/api/mixins/ActiveState.md

@@ -26,12 +26,12 @@ Let's say you are using bootstrap and want to get `active` on those `li`
 tags for the Tabs:
 
 ```js
-var Router = require('react-router');
-var Link = Router.Link;
+var Link = require('react-router/Link');
+var ActiveState = require('react-router/ActiveState');
 
 var Tab = React.createClass({
 
-  mixins: [ Router.ActiveState ],
+  mixins: [ ActiveState ],
 
   getInitialState: function () {
     return { isActive: false };

docs/guides/overview.md

@@ -2,8 +2,8 @@ Guide: Overview
 ===============
 
 ```
-var Routes = require('react-router').Routes;
-var Route = require('react-router').Route;
+var Routes = require('react-router/Routes');
+var Route = require('react-router/Route');
 
 React.renderComponent((
   <Routes>
@@ -50,7 +50,7 @@ will render the active child route handler.
 Here's the rest of the application:
 
 ```js
-var Link = require('react-router').Link;
+var Link = require('react-router/Link');
 
 var App = React.createClass({
   render: function() {

examples/animations/app.js

@@ -1,6 +1,6 @@
 /** @jsx React.DOM */
 var React = require('react');
-var Router = require('../../modules/main');
+var Router = require('../../index');
 var Routes = Router.Routes;
 var Route = Router.Route;
 var Link = Router.Link;

examples/auth-flow/app.js

@@ -1,6 +1,6 @@
 /** @jsx React.DOM */
 var React = require('react');
-var Router = require('../../modules/main');
+var Router = require('../../index');
 var Route = Router.Route;
 var Routes = Router.Routes;
 var Link = Router.Link;