diff --git a/README.md b/README.md index 3032399..742a3ba 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -SSR middleware for `react-relay-network-modern` (for Relay Modern) -========================================== +# SSR middleware for `react-relay-network-modern` (for Relay Modern) + [![](https://img.shields.io/npm/v/react-relay-network-modern-ssr.svg)](https://www.npmjs.com/package/react-relay-network-modern-ssr) [![npm](https://img.shields.io/npm/dt/react-relay-network-modern-ssr.svg)](http://www.npmtrends.com/react-relay-network-modern-ssr) [![Travis](https://img.shields.io/travis/nodkz/react-relay-network-modern-ssr.svg?maxAge=2592000)](https://travis-ci.org/nodkz/react-relay-network-modern-ssr) @@ -7,13 +7,13 @@ SSR middleware for `react-relay-network-modern` (for Relay Modern) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) ![FlowType compatible](https://img.shields.io/badge/flowtype-compatible-brightgreen.svg) - **For a full examples, see**: - - https://github.com/damassi/react-relay-network-modern-ssr-example - - https://github.com/damassi/react-relay-network-modern-ssr-todomvc -Server -======= +* https://github.com/damassi/react-relay-network-modern-ssr-example +* https://github.com/damassi/react-relay-network-modern-ssr-todomvc + +# Server + ```js import { RelayNetworkLayer } from 'react-relay-network-modern'; import RelayServerSSR from 'react-relay-network-modern-ssr/lib/server'; @@ -62,11 +62,10 @@ setTimeout(() => { const appHtml = ReactDOMServer.renderToString(); sendHtml(appHtml, relayData); }, 0) - ``` -Client -====== +# Client + ```js import { RelayNetworkLayer } from 'react-relay-network-modern'; import RelayClientSSR from 'react-relay-network-modern-ssr/lib/client'; @@ -91,15 +90,14 @@ ReactDOM.render( />, mountPoint ) - ``` -Contribute -========== + +# Contribute + I actively welcome pull requests with code and doc fixes. [CHANGELOG](https://github.com/nodkz/react-relay-network-modern-ssr/blob/master/CHANGELOG.md) +# License -License -======= [MIT](https://github.com/nodkz/react-relay-network-modern-ssr/blob/master/LICENSE.md)