From 2808808d055e5f78a23c7f1b983b6abfcc8bf06b Mon Sep 17 00:00:00 2001 From: Bo Borgerson Date: Fri, 3 Jun 2016 10:44:31 -0700 Subject: [PATCH] Better getting-started section of react-server README Taken from the top-level README, with absolute links pointing to npmjs.com (and github for the docs) instead of relative links within the repo. Also changed an instance of `react-server` to React Server. --- packages/react-server/README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/packages/react-server/README.md b/packages/react-server/README.md index f53e3a460..7194eccf5 100644 --- a/packages/react-server/README.md +++ b/packages/react-server/README.md @@ -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