react_rails_webpack 2.0.2 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4b0dff19a83c0ec6417746b7b8aec0a5014dc4f
-  data.tar.gz: 856fbb2cf877e0ba948fdc600d7b58e279f19581
+  metadata.gz: c564775a3830635f1296ef6927ed3421bbe54662
+  data.tar.gz: f7398865699cd5202092ebc330a13f996a2abd5f
 SHA512:
-  metadata.gz: f4c7b4e51d0e623dd3ce442b9ed0277d1ca208ec2c3d87a271d74173534cb9f408ff0dc6f127bb15c748a98698dbfa49f5b7b8e907772f1dc5408152ddc87ca5
-  data.tar.gz: 7d62db4616ecd75a0bb938a8365ced4b30e175ec55e2e311fb3354ab807a1fb90d0e8dc51ad85b2f16d0fdde6ddca94c772918efb105e485545a919d64e4bb81
+  metadata.gz: b6d301c7768c55a2ab4715d9ffcc0a9f7e1c8489ddbd98655664647894008ea392b98a654f68b64706c3770dfe635867548dff8b974d03d54911f6424bf0bffe
+  data.tar.gz: 30147f1de1a0648e9728696ee120fefb55d77be1f65eea3297c8f55909a453219ae9b94d45812bba029c032ff331bd22f6811c824981c65c4d44405793d0d40f

data/README.md

@@ -9,38 +9,59 @@ A set of Rails generators that create all the necessary boilerplate code (with e
 3. Automatically sets up working demo examples so you can jump into React immediately
 4. Development server for React components will live update your changes to any device on your local network (including phones)
 
-## Quick Start
-
-### Install
+## Install
 
 1. Make sure you have the [requirements](#requirements) installed
 2. Add `gem 'react_rails_webpack'` to your Gemfile
 3. Run `bundle install`
 4. Run `rails g react_rails_webpack:install` ([further explanation of what this does](#how-does-this-work))
 
-### Commands
+## See demo components
+
+### On webpack dev server
+
+1. Run the webpack dev server with `npm run start`
+2. Go to the url specified by the `rake react_rails_webpack:print_server_info` command
+
+### On your rails app
+
+1. Generate an example page in rails with the `rails g react_rails_webpack:create_example_page` command
+2. Start your Rails server with `rails s`
+3. Go to [localhost:3000/greeting](localhost:3000/greeting)
+
+## Commands
 
-#### `rails g react_rails_webpack:install`
+### Set up the integration
 
-Sets up the integration
+`rails g react_rails_webpack:install`
 
-#### `rails g react_rails_webpack:create_example_page`
+Further explanation of what this does [here](#how-does-this-work).
 
-Sets up an example page in your Rails app at  [localhost:3000/greeting](http://localhost:3000/greeting) that displays the two example components.
+### Sets up an example page in your Rails app
 
-#### `rails g react_rails_webpack:new_fork`
+`rails g react_rails_webpack:create_example_page`
 
-You must run this whenever you clone a repo with a react_rails_webpack integration setup. It generates [the environment.json file](lib/react_rails_webpack/client/environment.json) based on your computer's network name. Since the network name will be different for most computers, this file is gitignored and needs to be regenerated for each new computer the project is cloned on.
+Sets up an example page in your Rails app at [localhost:3000/greeting](http://localhost:3000/greeting) that displays the two example components.
 
-#### `rake react_rails_webpack:print_server_info`
+### Configure react_rails_webpack on a new clone of your repo
+
+`rails g react_rails_webpack:new_fork`
+
+**You must run this whenever you clone a repo with a react_rails_webpack integration setup**. It generates [the environment.json file](lib/react_rails_webpack/client/environment.json) based on your computer's network name. Since the network name will be different for most computers, this file is gitignored and needs to be regenerated for each new computer the project is cloned on.
+
+### See the url of your webpack development server
+
+`rake react_rails_webpack:print_server_info`
 
 This command will tell you the url of your webpack development server on your local network.
 
-#### `rails g react_rails_webpack:trailblazer_integration`
+### Generate react component Trailblazer cell
+
+`rails g react_rails_webpack:trailblazer_integration`
 
 If you use the Trailblazer gem, use this command to add a [trailblazer](https://github.com/apotonick/trailblazer) cell for react components to your `lib` folder.
 
-### Suggested Development Workflow
+## Suggested Development Workflow
 
 1. Write the code for your React components in the [client/src/components](lib/react_rails_webpack/client/src/components) directory
 2. Test your new components with live reloading by running the webpack dev server with the command `npm run start` (note: the base html page for the webpack dev server is based on the html provided to `context.defaultTemplate` in [the webpack.config.js file](lib/react_rails_webpack/client/webpack.config.js))

data/lib/react_rails_webpack/version.rb

@@ -1,3 +1,3 @@
 module ReactRailsWebpack
-  VERSION = "2.0.2"
+  VERSION = "2.0.3"
 end

data/lib/tasks/print_server_info.rake

@@ -5,8 +5,8 @@ namespace :react_rails_webpack do
     puts
     puts "-" * `tput cols`.to_i # print line of dashes
     puts
-    puts "To run a live-reloading webpack server for you React \
-  components, run #{'npm run start'.white.bold}, then go to #{(`scutil --get LocalHostName`.strip + '.local:3000').blue.bold}"
+    puts "To run a live-reloading webpack server for your React \
+components, run #{'npm run start'.white.bold}, then go to #{(`scutil --get LocalHostName`.strip + '.local:3000').blue.bold}"
     puts
     puts "-" * `tput cols`.to_i # print line of dashes
     puts

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: react_rails_webpack
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3
 platform: ruby
 authors:
 - Neurodynamic