Updated README with new phrasing (it IS the base for generator-react-webpack now)

This commit is contained in:
Chris
2015-10-21 16:06:42 +02:00
parent 71d7fa388d
commit e167efec72
+6 -7
View File
@@ -5,26 +5,25 @@ It can be understood as the prototype for newly generated projects.
[![Build Status](https://travis-ci.org/weblogixx/react-webpack-template.svg)](https://travis-ci.org/weblogixx/react-webpack-template) [![Build Status](https://travis-ci.org/weblogixx/react-webpack-template.svg)](https://travis-ci.org/weblogixx/react-webpack-template)
## Features ## Features
The following features are planned to be included in the final version: The following features are currently included:
- [x] Webpack and Webpack-Dev-Server, including hot-loader - [x] Webpack and Webpack-Dev-Server, including hot-loader
- [x] Babel and JSX - [x] Babel and JSX
- [x] Mocha Unit tests (*optional*) - [x] Mocha Unit tests (*optional*)
- [x] EsLint Support - [x] EsLint Support
- [x] No dependency on grunt, gulp or the next hot taskrunner! - [x] No dependency on grunt, gulp or the next hot taskrunner!
- [x] The dynamic webpack configuration is clunky, there must be a better way to do that!
- [x] Karmas webpack configuration is not included in the global webpack.config.js file, but it really should
- [x] Support for environment-specific configuration files - [x] Support for environment-specific configuration files
## Todo ## Todo
- [ ] Better performance for webpack builds - [ ] Better performance for webpack builds
## What is it for? ## What is it for?
This template can be used directly for the creation of new projects. This template can be used directly for the creation of new projects. When using it like this, make sure to ___not___ install it via npm but download it directly. The template is (nearly) useless for itself when downloaded via npm!
Also it will be the "template" for the next version of generator-react-webpack.
Basically, it is currently only used as the base template of [generator-react-webpack](https://github.com/newtriks/generator-react-webpack).
## Using it ## Using it
The template is available via webpack. The following commands are available: The template uses webpack as build tool to serve files and run tests. The following commands are available:
```bash ```bash
# Start for development # Start for development
npm start # or npm start # or
@@ -70,6 +69,6 @@ webpack-dev-server --env=dist
react-webpack-template is available under MIT-License and can therefore be used in any project free of charge. react-webpack-template is available under MIT-License and can therefore be used in any project free of charge.
## Contributors ## Contributors
- Weblogixx (cs@weblogixx.de) - Christian Schilling (cs@weblogixx.de)
- Martin Jul (martin@mjul.com) - Martin Jul (martin@mjul.com)
- Stephan Herzog (sthzgvie@gmail.com) - Stephan Herzog (sthzgvie@gmail.com)