From 40efe645170e3c6a1a003e95d4734d00069d03c0 Mon Sep 17 00:00:00 2001 From: Juan Picado Date: Wed, 22 Jun 2022 21:33:01 +0200 Subject: [PATCH] chore: update readme --- README.md | 38 +++++++++++++++++++++++++++----------- 1 file changed, 27 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 2874ca152..05bfa1e78 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,7 @@ Google Cloud Storage** or create your own plugin. [![Twitter followers](https://img.shields.io/twitter/follow/verdaccio_npm.svg?style=social&label=Follow)](https://twitter.com/verdaccio_npm) [![Github](https://img.shields.io/github/stars/verdaccio/verdaccio.svg?style=social&label=Stars)](https://github.com/verdaccio/verdaccio/stargazers) +[![StandWithUkraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md) ## Install @@ -37,6 +38,17 @@ npm install --global verdaccio Are you still using **Verdaccio 4**?. Check the [migration guide](https://verdaccio.org/blog/2021/04/14/verdaccio-5-migration-guide). +## Plugins + +You can develop your own [plugins](https://verdaccio.org/docs/plugins) with the [verdaccio generator](https://github.com/verdaccio/generator-verdaccio-plugin). Installing [Yeoman](https://yeoman.io/) is required. + +``` +npm install -g yo +npm install -g generator-verdaccio-plugin +``` + +Learn more [here](https://verdaccio.org/docs/dev-plugins) how to develop plugins. Share your plugins with the community. + ## Donations Verdaccio is run by **volunteers**; nobody is working full-time on it. If you find this project to be useful and would like to support its development and maintenance. @@ -65,26 +77,29 @@ If you want to use a modified version of some 3rd-party package (for example, yo ### E2E Testing Verdaccio has proved to be a lightweight registry that can be -booted in a couple of seconds, fast enough for any CI. Many open source projects use verdaccio for end to end testing, to mention some examples, **create-react-app**, **mozilla neutrino**, **pnpm**, **storybook**, **alfresco** or **eclipse theia**. You can read more in dedicated article to E2E in our blog. +booted in a couple of seconds, fast enough for any CI. Many open source projects use verdaccio for end to end testing, to mention some examples, **create-react-app**, **mozilla neutrino**, **pnpm**, **storybook**, **babel.js, **angular-cli** or **docusaurus\*\*. You can read more in [here](https://verdaccio.org/docs/e2e). -## Next talks +Furthermore, here few examples how to start: -- [**Deep dive into Verdaccio, a lightweight Node.js registry - June 29th 2022**](https://www.nodetlv.com/) -- [**How to improve your workflows with Verdaccio, your private Node.js registry - Global Summit for Node.js - May 18th 2022**](https://events.geekle.us/nodejs/) +- [e2e-ci-example-gh-actions](https://github.com/juanpicado/e2e-ci-example-gh-actions) +- [verdaccio-end-to-end-tests](https://github.com/juanpicado/verdaccio-end-to-end-tests) +- [verdaccio-fork](https://github.com/juanpicado/verdaccio-fork) -## The latest talk +## Watch our Videos + +**Node Congress 2022, February 2022, Online Free**
- nodejs + nodejs
You might want to check out as well our previous talks: -- [Using Docker and Verdaccio to make Integration Testing Easy - Docker All Hands #4 December - **Juan Picado** - 2021](https://www.youtube.com/watch?v=zRI0skF1f8I) -- [**Juan Picado** – Testing the integrity of React components by publishing in a private registry](https://www.youtube.com/watch?v=bRKZbrlQqLY&t=16s&ab_channel=ReactFinland) -- [BeerJS Cba Meetup No. 53 May 2021 - **Juan Picado** React Finland - 2021](https://www.youtube.com/watch?v=6SyjqBmS49Y&ab_channel=BeerJSCba) +- [Using Docker and Verdaccio to make Integration Testing Easy - **Docker All Hands #4 December - 2021**](https://www.youtube.com/watch?v=zRI0skF1f8I) +- [**Juan Picado** – Testing the integrity of React components by publishing in a private registry - React Finland - 2021](https://www.youtube.com/watch?v=bRKZbrlQqLY&t=16s&ab_channel=ReactFinland) +- [BeerJS Cba Meetup No. 53 May 2021 - **Juan Picado**](https://www.youtube.com/watch?v=6SyjqBmS49Y&ab_channel=BeerJSCba) - [Node.js Dependency Confusion Attacks - April 2021 - **Juan Picado**](https://www.youtube.com/watch?v=qTRADSp3Hpo) - [**OpenJS World 2020** about \*Cover your Projects with a Multi purpose Lightweight Node.js Registry - **Juan Picado**](https://www.youtube.com/watch?v=oVCjDWeehAQ) - [ViennaJS Meetup - Introduction to Verdaccio by **Priscila Olivera** and **Juan Picado**](https://www.youtube.com/watch?v=hDIFKzmoCa) @@ -216,6 +231,7 @@ You can find and chat with then over Discord, click [here](http://chat.verdaccio - [create-react-app](https://github.com/facebook/create-react-app/blob/master/CONTRIBUTING.md#customizing-e2e-registry-configuration) _(+86.2k ⭐️)_ - [Gatsby](https://github.com/gatsbyjs/gatsby) _(+49.2k ⭐️)_ - [Babel.js](https://github.com/babel/babel) _(+38.5k ⭐️)_ +- [Docusaurus](https://github.com/facebook/docusaurus) _(+34k ⭐️)_ - [Vue CLI](https://github.com/vuejs/vue-cli) _(+27.4k ⭐️)_ - [Angular CLI](https://github.com/angular/angular-cli) _(+24.3k ⭐️)_ - [Uppy](https://github.com/transloadit/uppy) _(+23.8k ⭐️)_ @@ -230,7 +246,7 @@ You can find and chat with then over Discord, click [here](http://chat.verdaccio - [Amazon SDK v3](https://github.com/aws/aws-sdk-js-v3) - [Amazon Encryption SDK for Javascript](https://github.com/aws/aws-encryption-sdk-javascript) -🤓 Don't be shy, you also can be in [the list](https://github.com/verdaccio/website/blob/master/docs/who-is-using.md). +🤓 Don't be shy, add yourself to this readme. ## Open Collective Sponsors @@ -277,7 +293,7 @@ If you have any issue you can try the following options, do no desist to ask or - [Donations](https://github.com/sponsors/verdaccio) - [Reporting an issue](https://github.com/verdaccio/verdaccio/issues/new/choose) - [Running discussions](https://github.com/verdaccio/verdaccio/issues?q=is%3Aissue+is%3Aopen+label%3Adiscuss) -- [Chat](http://chat.verdaccio.org/) +- [Chat](https://discord.gg/7qWJxBf) - [Logos](https://verdaccio.org/docs/en/logo) - [Docker Examples](https://github.com/verdaccio/verdaccio/tree/master/docker-examples) - [FAQ](https://github.com/verdaccio/verdaccio/discussions/categories/q-a)