chore: add missing READMES to packages (#545)

packages/add/README.md

@@ -2,7 +2,7 @@
 
 ## Description
 
-This package contains the logic to add new properties to the a webpack configuration file. It will run a generator that prompts the user for questions of which property to add to their webpack configuration file.
+This package contains the logic to add new properties in a webpack configuration file. It will run a generator that prompts the user for questions of which property to add to their webpack configuration file.
 
 ## Installation
 

packages/generate-loader/README.md

@@ -0,0 +1,27 @@
+# webpack-cli generate-loader
+
+## Description
+
+This package contains the logic to initiate new loader projects.
+
+## Installation
+
+```bash
+npm i -D webpack-cli @webpack-cli/generate-loader
+```
+
+## Usage
+
+To run the package programmatically, install it as a dependency. When using the package programmatically, one does not have to install webpack-cli.
+
+### Node
+
+```js
+const generateLoader = require("@webpack-cli/generate-loader");
+generateLoader();
+```
+
+### CLI (via `webpack-cli`)
+```bash
+npx webpack-cli generate-loader
+```

packages/generate-plugin/README.md

@@ -0,0 +1,26 @@
+# webpack-cli generate-plugin
+
+## Description
+
+This package contains the logic to initiate new plugin projects.
+
+## Installation
+
+```bash
+npm i -D webpack-cli @webpack-cli/generate-plugin
+```
+
+## Usage
+
+To run the package programmatically, install it as a dependency. When using the package programmatically, one does not have to install webpack-cli.
+
+### Node
+```js
+const generatePlugin = require("@webpack-cli/generate-plugin");
+generatePlugin();
+```
+
+### CLI (via `webpack-cli`)
+```bash
+npx webpack-cli generate-plugin
+```

packages/generators/README.md

@@ -0,0 +1,34 @@
+# webpack-cli generators
+
+## Description
+
+This package contains all webpack-cli related yeoman generators. 
+
+## Installation
+
+```bash
+npm i -D webpack-cli @webpack-cli/generators
+```
+
+## Usage
+
+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
+```

packages/info/README.md

@@ -2,7 +2,7 @@
 
 ## Description
 
-It returns a set of information related to the local enviroment.
+This pacakge returns a set of information related to the local enviroment.
 
 ## Installation
 
@@ -13,6 +13,7 @@ npm i -D @webpack-cli/info
 ## Usage
 
 ### Node
+
 ```js
 const envinfo = require("@webpack-cli/info");
 envinfo();

packages/init/README.md

@@ -0,0 +1,32 @@
+# webpack-cli init
+
+## Description
+
+This package contains the logic to create a new webpack configuration.
+
+## Installation
+
+```bash
+npm i -D webpack-cli @webpack-cli/init
+```
+
+## Usage
+
+To run the package programmatically, install it as a dependency. When using the package programmatically, one does not have to install webpack-cli.
+
+### Node
+
+```js
+const init = require("@webpack-cli/init");
+
+// this will run the default init instance
+init();
+
+ // we're slicing node.process, ...myPacakges is a webpack-scaffold name/path
+init([null, null, ...myPacakges]);
+```
+
+### CLI (via `webpack-cli`)
+```bash
+npx webpack-cli init
+```

packages/make/README.md

@@ -0,0 +1,26 @@
+# webpack-cli make (Work in Progress, not yet published)
+
+## Description
+
+This package contains the logic to run a makefile command similar to C in webpack. 
+
+## Installation
+
+```bash
+npm i -D webpack-cli @webpack-cli/make
+```
+
+## Usage
+
+To run the package programmatically, install it as a dependency. When using the package programmatically, one does not have to install webpack-cli.
+
+### Node
+```js
+const make = require("@webpack-cli/make");
+make();
+```
+
+### CLI (via `webpack-cli`)
+```bash
+npx webpack-cli make
+```

packages/migrate/README.md

@@ -0,0 +1,28 @@
+# webpack-cli migrate
+
+## Description
+
+This package contains the logic to migrate a project from one version to the other.
+
+## Installation
+
+```bash
+npm i -D webpack-cli @webpack-cli/migrate
+```
+
+## Usage
+
+To run the package programmatically, install it as a dependency. When using the package programmatically, one does not have to install webpack-cli.
+
+### Node
+```js
+const migrate = require("@webpack-cli/migrate");
+
+// add null to mock process.env
+migrate(null, null, inputPath, outputPath);
+```
+
+### CLI (via `webpack-cli`)
+```bash
+npx webpack-cli migrate
+```

packages/remove/README.md

@@ -0,0 +1,26 @@
+# webpack-cli remove
+
+## Description
+
+This package contains the logic to remove  properties of a webpack configuration file. It will run a generator that prompts the user for questions of which property to remove in their webpack configuration file.
+
+## Installation
+
+```bash
+npm i -D webpack-cli @webpack-cli/remove
+```
+
+## Usage
+
+To run the scaffolding instance programmatically, install it as a dependency. When using the package programmatically, one does not have to install webpack-cli.
+
+### Node
+```js
+const remove = require("@webpack-cli/remove");
+remove();
+```
+
+### CLI (via `webpack-cli`)
+```bash
+npx webpack-cli remove
+```

packages/serve/README.md

@@ -0,0 +1,26 @@
+# webpack-cli serve
+
+## Description
+
+This package contains the logic to run webpack-serve without using webpack-serve directly.
+
+## Installation
+
+```bash
+npm i -D webpack-cli @webpack-cli/serve
+```
+
+## Usage
+
+To run the scaffolding instance programmatically, install it as a dependency. When using the package programmatically, one does not have to install webpack-cli.
+
+### Node
+```js
+const serve = require("@webpack-cli/serve");
+serve();
+```
+
+### CLI (via `webpack-cli`)
+```bash
+npx webpack-cli serve
+```

packages/update/README.md

@@ -0,0 +1,26 @@
+# webpack-cli update
+
+## Description
+
+This package contains the logic to update properties in a webpack configuration file. It will run a generator that prompts the user for questions of which property to update in their webpack configuration file.
+
+## Installation
+
+```bash
+npm i -D webpack-cli @webpack-cli/update
+```
+
+## Usage
+
+To run the scaffolding instance programmatically, install it as a dependency. When using the package programmatically, one does not have to install webpack-cli.
+
+### Node
+```js
+const update = require("@webpack-cli/update");
+update();
+```
+
+### CLI (via `webpack-cli`)
+```bash
+npx webpack-cli update
+```

packages/utils/README.md

@@ -0,0 +1,29 @@
+# webpack-cli utils (WIP, not yet published)
+
+## Description
+
+This package contains the utilities used across the webpack-cli repositories.
+
+## Installation
+
+```bash
+npm i -D webpack-cli @webpack-cli/utils
+```
+
+## Contents
+ - AST transformations
+ - Checking NPM registry
+ - A Recursive AST parser
+ - Checking Local Configurations
+ - Yeoman Generator Adapter
+ - Package Resolver
+ - Test Utilities for Jest
+
+## Usage
+
+### Node
+
+```js
+const utils = require("@webpack-cli/utils");
+// API yet to be exposed
+```