aboutsummaryrefslogtreecommitdiff
path: root/node_modules/react/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/react/README.md')
-rw-r--r--node_modules/react/README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/node_modules/react/README.md b/node_modules/react/README.md
new file mode 100644
index 000000000..740a4f2c0
--- /dev/null
+++ b/node_modules/react/README.md
@@ -0,0 +1,16 @@
+# react
+
+An npm package to get you immediate access to [React](https://facebook.github.io/react/),
+without also requiring the JSX transformer. This is especially useful for cases where you
+want to [`browserify`](https://github.com/substack/node-browserify) your module using
+`React`.
+
+**Note:** by default, React will be in development mode. The development version includes extra warnings about common mistakes, whereas the production version includes extra performance optimizations and strips all error messages.
+
+To use React in production mode, set the environment variable `NODE_ENV` to `production`. A minifier that performs dead-code elimination such as [UglifyJS](https://github.com/mishoo/UglifyJS2) is recommended to completely remove the extra code present in development mode.
+
+## Example Usage
+
+```js
+var React = require('react');
+```