aboutsummaryrefslogtreecommitdiff
path: root/node_modules/react-dom/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/react-dom/README.md')
-rw-r--r--node_modules/react-dom/README.md54
1 files changed, 54 insertions, 0 deletions
diff --git a/node_modules/react-dom/README.md b/node_modules/react-dom/README.md
new file mode 100644
index 000000000..79e5133a1
--- /dev/null
+++ b/node_modules/react-dom/README.md
@@ -0,0 +1,54 @@
+# `react-dom`
+
+This package serves as the entry point of the DOM-related rendering paths. It is intended to be paired with the isomorphic React, which will be shipped as `react` to npm.
+
+## Installation
+
+```sh
+npm install react react-dom
+```
+
+## Usage
+
+### In the browser
+
+```js
+var React = require('react');
+var ReactDOM = require('react-dom');
+
+class MyComponent extends React.Component {
+ render() {
+ return <div>Hello World</div>;
+ }
+}
+
+ReactDOM.render(<MyComponent />, node);
+```
+
+### On the server
+
+```js
+var React = require('react');
+var ReactDOMServer = require('react-dom/server');
+
+class MyComponent extends React.Component {
+ render() {
+ return <div>Hello World</div>;
+ }
+}
+
+ReactDOMServer.renderToString(<MyComponent />);
+```
+
+## API
+
+### `react-dom`
+
+- `findDOMNode`
+- `render`
+- `unmountComponentAtNode`
+
+### `react-dom/server`
+
+- `renderToString`
+- `renderToStaticMarkup`