Skip to content

Commit

Permalink
Merge pull request #260 from gigabo/readme-tweak
Browse files Browse the repository at this point in the history
Better getting-started section of react-server README
  • Loading branch information
gigabo committed Jun 3, 2016
2 parents f0d9ad6 + 2808808 commit 2032f9f
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions packages/react-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,19 @@ transitions between pages in the browser.

## What is it?

`react-server` is an [Express](http://expressjs.com/) [middleware](http://expressjs.com/guide/using-middleware.html)
React Server is an [Express](http://expressjs.com/) [middleware](http://expressjs.com/guide/using-middleware.html)
for serving universal (isomorphic) JavaScript applications built with [React](https://facebook.github.io/react/)
based on the [Flux pattern](https://facebook.github.io/flux/docs/overview.html).
Read more on [our dev blog](https://www.redfin.com/blog/tag/react-server).

## Getting started

For now it's easiest to get started with
[`react-server-cli`](https://www.npmjs.com/package/react-server-cli).
The _easiest_ way to get started is with our [yeoman generator](https://www.npmjs.com/package/generator-react-server).

That hooks you up with [`react-server-cli`](https://www.npmjs.com/package/react-server-cli), which
will take care of the _server_ part and get you up and running right away.

Once you're hungry for more dig into [the docs](https://github.com/redfin/react-server/tree/master/docs).

[build-badge-img]: https://travis-ci.org/redfin/react-server.svg?branch=master
[build-url]: https://travis-ci.org/redfin/react-server
Expand Down

0 comments on commit 2032f9f

Please sign in to comment.