Skip to content

Commit

Permalink
docs: update generators README
Browse files Browse the repository at this point in the history
  • Loading branch information
rishabh3112 committed Dec 28, 2018
1 parent d17cae1 commit e54b788
Showing 1 changed file with 10 additions and 11 deletions.
21 changes: 10 additions & 11 deletions packages/generators/README.md
Expand Up @@ -14,21 +14,20 @@ npm i -D webpack-cli @webpack-cli/generators

To run the package programmatically, install it as a dependency. When using the package programmatically, one does not have to install webpack-cli.

## Generators

- Plugin Generator
- Remove Generator
- Update Generator
- Loader Generator
- Init Generator
- Add Generator


### Node

```js
const { addGenerator, addonGenerator, initGenerator, loaderGenerator,
pluginGenerator, removeGenerator, updateGenerator
} = require("@webpack-cli/generators");
// ... compose with yeoman env or add a generator to your own yeoman project
```
```
## Generators

- **Plugin Generator** : Creates a webpack plugin project, add starter plugin code and runs `webpack-defaults`
- **Remove Generator** : Removes properties from webpack configurations
- **Update Generator** : [WIP] Updates properties of webpack configurations
- **Loader Generator** : Creates a webpack loader project, add starter loader code and runs `webpack-defaults`
- **Init Generator** : Generates new webapck configuration as per user requirements
- **Add Generator** : Add properties to webpack configurations
- **Addon Generator** : Generates a webpack project conforming to `webpack-defaults`

0 comments on commit e54b788

Please sign in to comment.