react_rails_webpack 2.0.3 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c564775a3830635f1296ef6927ed3421bbe54662
-  data.tar.gz: f7398865699cd5202092ebc330a13f996a2abd5f
+  metadata.gz: a2e0e208bffed31ac0fea62fccf7ff0f3b6fba56
+  data.tar.gz: 53ae37a29df2cda276e2e0ccd8e75238657c2e79
 SHA512:
-  metadata.gz: b6d301c7768c55a2ab4715d9ffcc0a9f7e1c8489ddbd98655664647894008ea392b98a654f68b64706c3770dfe635867548dff8b974d03d54911f6424bf0bffe
-  data.tar.gz: 30147f1de1a0648e9728696ee120fefb55d77be1f65eea3297c8f55909a453219ae9b94d45812bba029c032ff331bd22f6811c824981c65c4d44405793d0d40f
+  metadata.gz: d662fff84b84af5030fd960e0e9e93e460b81af1155dcfcdb9250395b2138757aad7b6d28dd7ea691eb238e5c79ebd7ea5fcbc7d370dbe9101d1745bbbffeb35
+  data.tar.gz: 73ce7f41b6ab4f01b50d886a537d3332f76bcd0aeb8bae1b420483abd114a58b68516683ee36ccfb247c36d330298749dbfc7bc1fd4d3443364e9308a71797cf

data/README.md

@@ -16,7 +16,13 @@ A set of Rails generators that create all the necessary boilerplate code (with e
 3. Run `bundle install`
 4. Run `rails g react_rails_webpack:install` ([further explanation of what this does](#how-does-this-work))
 
-## See demo components
+## Requirements
+
+- Rails version 4 or greater
+- node version 4 or greater
+- npm version 3 or greater
+
+## See the demo components in action
 
 ### On webpack dev server
 
@@ -37,7 +43,7 @@ A set of Rails generators that create all the necessary boilerplate code (with e
 
 Further explanation of what this does [here](#how-does-this-work).
 
-### Sets up an example page in your Rails app
+### Set up an example page in your Rails app
 
 `rails g react_rails_webpack:create_example_page`
 
@@ -123,14 +129,14 @@ export default {
 - Wherever you want this component to render in your view, put a call to the `react_component` helper method with the components name and props, like so:
 
 ```ruby
-render_component "CheckoutForm", { customerName: 'Harper' }
+render_component :CheckoutForm, { customerName: 'Harper' }
 ```
 
-NOTE: Unless you're sure you know what you're doing, do not edit anything in the [client/app](lib/react_rails_webpack/client/app) folder except [the availableComponents file](lib/react_rails_webpack/client/app/availableComponents.js)). Those files are where the integration works it's magic (though of course feel free to read the files to check out how everything works).
+NOTE: Unless you're sure you know what you're doing, do not edit anything in the [client/app](lib/react_rails_webpack/client/src/app) folder except [the availableComponents file](lib/react_rails_webpack/client/src/app/availableComponents.js)). Those files are where the integration works it's magic (though of course feel free to read the files to check out how everything works).
 
 ## Working with the Webpack Dev Server
 
-`npm run start` will start a webpack development server with hot reloading that is completely independent of your Rails app. You can see the output of this server on any computer or mobile device on your local network by going to the appropriate url (which you can find by running `rails g react_rails_webpack:info`). Any changes you make to your component files will be pushed immediately to all devices looking at the page.
+`npm run start` will start a webpack development server with hot reloading that is completely independent of your Rails app. You can see the output of this server on any computer or mobile device on your local network by going to the appropriate url (which you can find by running `rake react_rails_webpack:print_server_info`). Any changes you make to your component files will be pushed immediately to all devices looking at the page.
 
 ## How does this work?
 
@@ -140,7 +146,7 @@ When you run the install generator like this:
 
 This gem will setup a basic react integration with some example components (one standard react component and one using react with redux) under [a client folder](lib/react_rails_webpack/client) in your project's root.
 
-The meat of the integration with Rails is in [the client/app folder](lib/react_rails_webpack/client/app), and [the app.js file](lib/react_rails_webpack/client/app.js). When your page loads in Rails, the `react_component` method creates divs that looks like this:
+The meat of the integration with Rails is in [the client/app folder](lib/react_rails_webpack/client/src/app), and [the app.js file](lib/react_rails_webpack/client/src/app.js). When your page loads in Rails, the `react_component` method creates divs that looks like this:
 
 ```html
 <div class="react-component-target" data-componentname="ComponentName" data-componentprops="{myProp: 'some value'}">
@@ -184,7 +190,7 @@ Assuming `react_component` finds a component that matches the it's given, it wil
 
 Remember, while your changes to components will hot reload when you use the webpack dev server, they will not show up at all in your Rails app until you run the `npm run build` command. And they do NOT hot-reload when run in the context of your Rails app.
 
-### Forgetting to add components to the `client/src/app/availableComponents.js` file
+### Forgetting to add components to the [client/src/app/availableComponents.js](lib/react_rails_webpack/client/src/app/availableComponents.js) file
 
 Components will not be accessible from Rails if you forget to add them here.
 

data/lib/react_rails_webpack/version.rb

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

metadata

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