Skip to content

Commit

Permalink
Merge pull request #2 from tswayne/bugfix
Browse files Browse the repository at this point in the history
Bugfix
  • Loading branch information
tswayne authored Mar 28, 2017
2 parents e41f1db + e5ab493 commit c58bb60
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 1 deletion.
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# Change Log

## [2.0.3] - 3/27/2017
- Bug fix: Update readme for npm

## [2.0.2] - 3/27/2017
- Bug fix: Remove binary file extension

## [2.0.1] - 3/27/2017
- Bug fix: Add file type to top of binary file

## [2.0.0] - 3/27/2017
- Create cli

Expand Down
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ There are tons of resources and tools out there to help developers get started w
are not many tools out there there to help those who want to add react to an existing app (built with node). React-helper makes it extremely easy to
add react components to your views, so you can jump right into writing react components without having to worry too much about setup.

## Installing
##### CLI install
`npm install -g react-helper`
##### Adding to your app
`npm install react-helper --save`

### Table of Contents
* [Features](#features)
* [Getting Started](#getting-started)
Expand All @@ -14,6 +20,7 @@ add react components to your views, so you can jump right into writing react com
* [Example application](#example)

<a id="features"></a>

## Features:
* Setting up is a breeze. Add react to your app with one command using the cli.

Expand Down Expand Up @@ -57,8 +64,11 @@ add react components to your views, so you can jump right into writing react com
res.render('view-to-render', {component})
```
<a id="getting-started"></a>
## Getting started
<a id="cli"></a>
### Using the CLI
You can now add react-helper to your app with one command!
Expand All @@ -74,6 +84,7 @@ add react components to your views, so you can jump right into writing react com
-w, --webpack Add webpack and generate config
<a id="manual"></a>
### Manually add react-helper to your application
Getting started is simple:
Expand Down Expand Up @@ -127,7 +138,9 @@ add react components to your views, so you can jump right into writing react com
<h1>This view has react in it</h1>
{{{component}}}
```
<a id="setup"></a>
### Setup
_You can generate a webpack config when adding react-helper to your application with the CLI using the -w option_
Expand Down Expand Up @@ -158,6 +171,7 @@ add react components to your views, so you can jump right into writing react com
```
<a id="server-side"></a>
## Server side rendering
Server-side rendering can be very [useful](https://www.smashingmagazine.com/2016/03/server-side-rendering-react-node-express/). This library makes it very easy to server-side render your components. There are two methods to server-side rendering:
**If you are using JSX in your components and would like to render your components server side** - you must pre-compile your files, see https://github.com/babel/example-node-server as an example. More coming soon.
Expand All @@ -178,6 +192,7 @@ add react components to your views, so you can jump right into writing react com
```
<a id="example"></a>
## Example
Check out an example app generated with the react-helper cli using the library - https://github.com/tswayne/react-helper-example
Expand Down
1 change: 1 addition & 0 deletions bin/react-helper.js → bin/react-helper
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
#!/usr/bin/env node
var program = require('commander');
var exec = require('child_process').exec;
var fs = require('fs');
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "react-helper",
"version": "2.0.0",
"version": "2.0.3",
"description": "A helper that makes it extremely easy to add react to your node app.",
"main": "index.js",
"scripts": {
Expand Down

0 comments on commit c58bb60

Please sign in to comment.