Skip to content

Commit 2958ebb

Browse files
committed
Default Yeoman Readme replaced with basic description getting started.
1 parent e9d5cb9 commit 2958ebb

1 file changed

Lines changed: 11 additions & 28 deletions

File tree

README.md

Lines changed: 11 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,31 @@
11
# generator-webpack-redux-react
22

3-
Helps start and build projects using [React](https://facebook.github.io/react/) and [Redux](https://github.com/rackt/redux).
4-
5-
> [Yeoman](http://yeoman.io) generator
6-
3+
Generator for a webpack-redux-react project with sub-generators for Components, Containers(Redux linked component), as well as Redux Actions and Reducers.
74

85
## Getting Started
96

10-
### What is Yeoman?
11-
12-
Trick question. It's not a thing. It's this guy:
13-
14-
![](http://i.imgur.com/JHaAlBJ.png)
15-
16-
Basically, he wears a top hat, lives in your computer, and waits for you to tell him what kind of application you wish to create.
17-
18-
Not every new computer comes with a Yeoman pre-installed. He lives in the [npm](https://npmjs.org) package repository. You only have to ask for him once, then he packs up and moves into your hard drive. *Make sure you clean up, he likes new and shiny things.*
19-
7+
Before:
8+
* Install yeoman if you don't have it:
209
```bash
2110
npm install -g yo
2211
```
2312

24-
### Yeoman Generators
25-
26-
Yeoman travels light. He didn't pack any generators when he moved in. You can think of a generator like a plug-in. You get to choose what type of application you wish to create, such as a Backbone application or even a Chrome extension.
27-
28-
To install generator-generator-kyper-react from npm, run:
13+
1. Install Generator:
2914

3015
```bash
31-
npm install -g generator-generator-kyper-react
16+
npm install -g generator-webpack-redux-react
3217
```
33-
34-
Finally, initiate the generator:
18+
2. Create a project folder and enter it:
3519

3620
```bash
37-
yo generator kyper react
21+
mkdir myProject && cd myProject
3822
```
3923

40-
### Getting To Know Yeoman
41-
42-
Yeoman has a heart of gold. He's a person with feelings and opinions, but he's very easy to work with. If you think he's too opinionated, he can be easily convinced.
43-
44-
If you'd like to get to know Yeoman better and meet some of his friends, [Grunt](http://gruntjs.com) and [Bower](http://bower.io), check out the complete [Getting Started Guide](https://github.com/yeoman/yeoman/wiki/Getting-Started).
24+
3.Initiate the generator:
4525

26+
```bash
27+
yo webpack-redux-react
28+
```
4629

4730
## License
4831

0 commit comments

Comments
 (0)