Skip to content

Commit 9c61be0

Browse files
committed
Added updated readme
1 parent 6516861 commit 9c61be0

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
> Yeoman generator for [ReactJS](http://facebook.github.io/react/) - lets you quickly set up a project including karma test runner and [Webpack](http://webpack.github.io/) module system.
44
55
# About
6-
Generator-React-Webpack will help you build new Reactprojects using modern technologies.
6+
Generator-React-Webpack will help you build new React projects using modern technologies.
77

88
Out of the box it comes with support for:
99
- Webpack
@@ -12,11 +12,14 @@ Out of the box it comes with support for:
1212
- Automatic code linting via esLint
1313
- Ability to unit test components via Karma and Mocha/Chai
1414

15-
## Subgenerators
16-
This generator is also the base project for some other generators that depend on it:
17-
### Generator-React-Webpack-Alt
18-
(https://github.com/weblogixx/generator-react-webpack-alt)
19-
Generator based on generator-react-webpack, providing support for Alt.js.
15+
## Changes in Version 2.0
16+
The new version of generator-react-webpack does __NOT__ include support for Flux-Frameworks directly. Instead, we will use it as a base to provide own generators that use it as a base. This will make the base generator easier to use and update.
17+
18+
Currently, there are no stable flux implementation based on generator-react-webpack v2. We are working on an implementation for alt.js.
19+
20+
If you are interested, feel free to write your own generator and use generator-react-webpack as a base (via composition).
21+
22+
If you have build a generator using generator-react-webpack, tell us and we will add a link to our README.
2023

2124
---
2225

@@ -73,11 +76,9 @@ npm run copy
7376
```
7477

7578
### Naming Components
76-
77-
I have opted to follow [@floydophone](https://twitter.com/floydophone) convention of uppercase for component file naming e.g. [Component.js](https://github.com/petehunt/ReactHack/tree/master/src/components). I am open to suggestions if there is a general objection to this decision.
79+
We have opted to follow [@floydophone](https://twitter.com/floydophone) convention of uppercase for component file naming e.g. [Component.js](https://github.com/petehunt/ReactHack/tree/master/src/components). I am open to suggestions if there is a general objection to this decision.
7880

7981
### Modules
80-
8182
Each component is a module and can be required using the [Webpack](http://webpack.github.io/) module system. [Webpack](http://webpack.github.io/) uses [Loaders](http://webpack.github.io/docs/loaders.html) which means you can also require CSS and a host of other file types. Read the [Webpack documentation](http://webpack.github.io/docs/home.html) to find out more.
8283

8384
## Props
@@ -91,7 +92,6 @@ Thanks to [Edd Hannay](https://github.com/eddhannay) for his Webpack optimisatio
9192
Contributions are welcomed. When submitting a bugfix, write a test that exposes the bug and fails before applying your fix. Submit the test alongside the fix.
9293

9394
### Running Tests
94-
9595
`npm test` or `node node_modules/.bin/mocha`
9696

9797
## License

0 commit comments

Comments
 (0)