resources / readme

Author: jashmenn

Diff for: LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Fullstack.io <fullstack.io>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

Diff for: README.md

@@ -1,27 +1,51 @@
-## Yelp clone
+<p align="center">
+  <img src="resources/readme/fullstackreact-yelp-clone-tutorial.png" alt="Fullstack React Yelp Clone Tutorial" />
+</p>
 
-TLDR: [demo](http://fullstackio.github.io/yelp-clone)
+# React Tutorial: Build a Yelp Clone [![Dolpins](https://cdn.rawgit.com/fullstackreact/react-yelp-clone/master/resources/readme/dolphins-badge-ff00ff.svg)](https://www.fullstackreact.com)
 
-This repository is the main repo for the app discussed and built in great detail at the [fullstackreact /blog](https://fullstackreact.com/blog). For an in-depth discussion, check out the post.
+> _tl;dr_ - This is the code for our blog post which will guide you through building a full React app, even with little to no experience in the framework. We're going build a Yelp clone in React
 
-## Getting yelp up and running
+See the [demo](http://fullstackio.github.io/yelp-clone) and [accompanying blog post](https://www.fullstackreact.com/articles/react-tutorial-cloning-yelp/).
 
-Getting the app up and running is straight-forward. Clone the repo, install the dependencies, and run the start script.
+Let's build a lightweight clone of Yelp using React.
 
-### Cloning the repo:
+In this tutorial we'll talk about:
 
-```bash
-$ git clone https://github.com/fullstackio/yelp-clone.git yelp
-$ cd yelp
-```
+- How to setup a new React project from scratch
+- How to create a basic React component
+- How to write modular CSS using `postcss`
+- How to setup testing
+- How route to different pages with `react-router`
+- How to integrate with Google Maps
+- How to write a Google Maps React component
+- How to write a five-star rating component
+
+We'll be tying in a lot of different pieces of [React](https://facebook.github.io/react/) together to build a full-sized React app. This post will guide you through building a full React app, even with little to no experience in the framework.
+
+<p align="center">
+  <img src="resources/readme/app-screenshot.png" />
+</p>
+
+## Quickstart
 
-### Install the dependencies
+First, clone the repository:
 
 ```bash
-$ npm install
+    git clone https://github.com/fullstackreact/react-yelp-clone.git react-yelp-clone
+    cd react-yelp-clone
+
+    # install the dependencies
+    npm install
+
+    # copy configuration (see below)
+    cp .env.example .env
+
+    # start the server
+    npm start
 ```
 
-### Configuring the application
+## Configuring the Application
 
 This app uses [dotenv](https://github.com/bkeepers/dotenv) for configuration. In order to configure the application for your own api access, grab an api token from google at [https://developers.google.com/maps/documentation/javascript/](https://developers.google.com/maps/documentation/javascript/) and set it in a file called `.env` at the root for a key called `__GAPI_KEY__`.
 For instance, say that your gapi key is: `abc123`. Your `.env` file should look like:
@@ -33,15 +57,18 @@ GAPI_KEY=abc123
 You can also create this file by copying the `.env.example` file at the root:
 
 ```bash
-$ cp .env.example .env
+cp .env.example .env
 ```
 
-### Starting the application
+## Starting the Application
 
 ```bash
-$ npm start
+npm install 
+npm start
 ```
 
+## Libraries We'll Use
+
 This app uses the following technologies:
 
 * [webpack](https://webpack.github.io)
@@ -55,7 +82,7 @@ This app uses the following technologies:
 * [chai](http://chaijs.com)
 * And much much more
 
-### Running the tests
+## Running the Tests
 
 The application is built using tests, including the fantastic [enzyme](https://github.com/airbnb/enzyme) and [chai](http://chaijs.com) libraries. To run the tests, use the `npm` test script:
 
@@ -73,5 +100,22 @@ cd yelp
 npm install
 npm start
 ```
+___
+
+# Fullstack React Book
+
+<a href="https://fullstackreact.com">
+<img align="right" src="resources/readme/fullstack-react-hero-book.png" alt="Fullstack React Book" width="155" height="250" />
+</a>
+
+This app was built alongside the blog post [React Tutorial: Cloning Yelp](https://www.fullstackreact.com/articles/react-tutorial-cloning-yelp/).
+
+This repo was written and is maintained by the [Fullstack React](https://fullstackreact.com) team. In the book we cover many more projects like this. We walk through each line of code, explain why it's there and how it works.
+
+This app is only one of several apps we have in the book. If you're looking to learn React, there's no faster way than by spending a few hours with the Fullstack React book.
+
+<div style="clear:both"></div>
+
+## License
+ [MIT](/LICENSE)
 
-[fullstackreact.com](https://fullstackreact.com)