From 2ca229aa60dad436b93315e8056f75990d179992 Mon Sep 17 00:00:00 2001 From: Juan Picado Date: Sat, 15 Jun 2024 19:33:31 +0200 Subject: [PATCH] Create README.md --- .../generator-verdaccio-plugin/README.md | 41 +++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 packages/tools/generator-verdaccio-plugin/README.md diff --git a/packages/tools/generator-verdaccio-plugin/README.md b/packages/tools/generator-verdaccio-plugin/README.md new file mode 100644 index 000000000..fecdd8726 --- /dev/null +++ b/packages/tools/generator-verdaccio-plugin/README.md @@ -0,0 +1,41 @@ +# Plugin Generator + +[![verdaccio (latest)](https://img.shields.io/npm/v/generator-verdaccio-plugin/latest.svg)](https://www.npmjs.com/package/generator-verdaccio-plugin) +[![verdaccio (downloads)](https://img.shields.io/npm/dy/generator-verdaccio-plugin.svg)](https://www.npmjs.com/package/generator-verdaccio-plugin) +[![docker pulls](https://img.shields.io/docker/pulls/verdaccio/verdaccio.svg?maxAge=43200)](https://verdaccio.org/docs/en/docker.html) +[![Backers](https://opencollective.com/verdaccio/tiers/backer/badge.svg?label=Backer&color=brightgreen)](https://opencollective.com/verdaccio) +[![Stackshare](https://img.shields.io/badge/Follow%20on-StackShare-blue.svg?logo=stackshare&style=flat)](https://stackshare.io/verdaccio) +[![Discord](https://img.shields.io/discord/388674437219745793?logo=discord)](http://chat.verdaccio.org/) +[![Twitter followers](https://img.shields.io/twitter/follow/verdaccio_npm.svg?style=social&label=Follow)](https://twitter.com/verdaccio_npm) + +Verdaccio plugin generator based in [Yeoman](http://yeoman.io) aims to help to scaffold plugins development + +## Installation + +First, install [Yeoman](http://yeoman.io) and generator-verdaccio-plugin using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)). + +```bash +npm install -g yo +npm install -g generator-verdaccio-plugin +``` + +Then generate your new project: + +```bash +yo verdaccio-plugin +``` + +## Plugin Types Supported + +- Authentication +- Storage +- Middleware + +### Maintainers + +- [Anix](https://github.com/anikethsaha) +- [Juan Picado](https://github.com/juanpicado) + +## License + +MIT © [Juan Picado <@jotadeveloper>]()