add notes

Author: juanpicado

src/app/index.ts

@@ -164,7 +164,11 @@ export default class PluginGenerator extends Generator {
     this.fs.copy(this.templatePath('common/npmignore'), dest('.npmignore'));
     this.fs.copy(this.templatePath('common/nvmrc'), dest('.nvmrc'));
 
-    this.fs.copyTpl(this.templatePath('common/README.md'), dest('README.md'), this.props);
+    this.fs.copyTpl(
+      this.templatePath(`${this.props.pluginType}/README.md`),
+      dest('README.md'),
+      this.props
+    );
 
     this.fs.copy(this.templatePath(`${this.props.pluginType}/src`), dest('src'));
     // this.fs.copy(this.templatePath('common/index.ts'), dest('index.ts'));

src/app/templates/auth/README.md

@@ -0,0 +1,36 @@
+# <%= name %>
+
+<%- (description || '').split('\n').map(function (line) {
+return '> ' + line
+}).join('\n') %>
+
+---
+
+## Usage
+
+Add the plugin to your Verdaccio configuration file (`config.yaml`):
+
+```yaml
+auth:
+  <%= name %>:
+    enabled: true
+```
+
+## Development
+
+See the [verdaccio contributing guide](https://github.com/verdaccio/verdaccio/blob/master/CONTRIBUTING.md) for instructions setting up your development environment.
+Once you have completed that, use the following npm tasks.
+
+- `npm run build`
+
+  Build a distributable archive
+
+- `npm run test`
+
+  Run unit test
+
+- `npm run verify`
+
+  Verify the plugin can be loaded by Verdaccio. This runs [`@verdaccio/plugin-verifier`](https://www.npmjs.com/package/@verdaccio/plugin-verifier) which checks that the plugin exports the correct interface and can be instantiated as an **authentication** plugin.
+
+For more information about any of these commands run `npm run ${task} -- --help`.

src/app/templates/filter/README.md

@@ -0,0 +1,36 @@
+# <%= name %>
+
+<%- (description || '').split('\n').map(function (line) {
+return '> ' + line
+}).join('\n') %>
+
+---
+
+## Usage
+
+Add the plugin to your Verdaccio configuration file (`config.yaml`):
+
+```yaml
+filters:
+  <%= name %>:
+    enabled: true
+```
+
+## Development
+
+See the [verdaccio contributing guide](https://github.com/verdaccio/verdaccio/blob/master/CONTRIBUTING.md) for instructions setting up your development environment.
+Once you have completed that, use the following npm tasks.
+
+- `npm run build`
+
+  Build a distributable archive
+
+- `npm run test`
+
+  Run unit test
+
+- `npm run verify`
+
+  Verify the plugin can be loaded by Verdaccio. This runs [`@verdaccio/plugin-verifier`](https://www.npmjs.com/package/@verdaccio/plugin-verifier) which checks that the plugin exports the correct interface and can be instantiated as a **filter** plugin.
+
+For more information about any of these commands run `npm run ${task} -- --help`.

src/app/templates/middleware/README.md

@@ -0,0 +1,36 @@
+# <%= name %>
+
+<%- (description || '').split('\n').map(function (line) {
+return '> ' + line
+}).join('\n') %>
+
+---
+
+## Usage
+
+Add the plugin to your Verdaccio configuration file (`config.yaml`):
+
+```yaml
+middlewares:
+  <%= name %>:
+    enabled: true
+```
+
+## Development
+
+See the [verdaccio contributing guide](https://github.com/verdaccio/verdaccio/blob/master/CONTRIBUTING.md) for instructions setting up your development environment.
+Once you have completed that, use the following npm tasks.
+
+- `npm run build`
+
+  Build a distributable archive
+
+- `npm run test`
+
+  Run unit test
+
+- `npm run verify`
+
+  Verify the plugin can be loaded by Verdaccio. This runs [`@verdaccio/plugin-verifier`](https://www.npmjs.com/package/@verdaccio/plugin-verifier) which checks that the plugin exports the correct interface and can be instantiated as a **middleware** plugin.
+
+For more information about any of these commands run `npm run ${task} -- --help`.

src/app/templates/storage/README.md

@@ -0,0 +1,36 @@
+# <%= name %>
+
+<%- (description || '').split('\n').map(function (line) {
+return '> ' + line
+}).join('\n') %>
+
+---
+
+## Usage
+
+Add the plugin to your Verdaccio configuration file (`config.yaml`):
+
+```yaml
+store:
+  <%= name %>:
+    enabled: true
+```
+
+## Development
+
+See the [verdaccio contributing guide](https://github.com/verdaccio/verdaccio/blob/master/CONTRIBUTING.md) for instructions setting up your development environment.
+Once you have completed that, use the following npm tasks.
+
+- `npm run build`
+
+  Build a distributable archive
+
+- `npm run test`
+
+  Run unit test
+
+- `npm run verify`
+
+  Verify the plugin can be loaded by Verdaccio. This runs [`@verdaccio/plugin-verifier`](https://www.npmjs.com/package/@verdaccio/plugin-verifier) which checks that the plugin exports the correct interface and can be instantiated as a **storage** plugin.
+
+For more information about any of these commands run `npm run ${task} -- --help`.