From 12da966254de2073bb9a769bee5ad4e0ded1c882 Mon Sep 17 00:00:00 2001 From: "Juan Picado @jotadeveloper" Date: Thu, 25 Apr 2019 19:49:19 +0200 Subject: [PATCH] chore: update readme --- README.md | 41 +++++++++++++++++++++++------------------ 1 file changed, 23 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 4f15d27..68a826f 100755 --- a/README.md +++ b/README.md @@ -3,26 +3,15 @@ # Version 4 UI Theme -[Verdaccio](https://verdaccio.org/) is a simple, **zero-config-required local private npm registry**. -No need for an entire database just to get started! Verdaccio comes out of the box with -**its own tiny database**, and the ability to proxy other registries (eg. npmjs.org), -caching the downloaded modules along the way. -For those looking to extend their storage capabilities, Verdaccio -**supports various community-made plugins to hook into services such as Amazon's s3, -Google Cloud Storage** or create your own plugin. +[Verdaccio](https://verdaccio.org/) UI is a [theme plugin](https://verdaccio.org/docs/en/dev-plugins#theme-plugin) build in React, Flow and Emotion. It uses Jest and Enzyme for Unit testing. -[![verdaccio (latest)](https://img.shields.io/npm/v/verdaccio/latest.svg)](https://www.npmjs.com/package/verdaccio) -[![verdaccio (next)](https://img.shields.io/npm/v/verdaccio/next.svg)](https://www.npmjs.com/package/verdaccio) -[![verdaccio (next)](http://img.shields.io/npm/dy/verdaccio.svg)](https://www.npmjs.com/package/verdaccio) +[![verdaccio (latest)](https://img.shields.io/npm/v/@verdaccio/ui-theme/latest.svg)](https://www.npmjs.com/package/verdaccio) [![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) - -![circle ci status](https://circleci.com/gh/verdaccio/verdaccio.svg?style=shield&circle-token=:circle-token) -[![codecov](https://img.shields.io/codecov/c/github/verdaccio/verdaccio/master.svg)](https://codecov.io/gh/verdaccio/verdaccio) [![discord](https://img.shields.io/discord/388674437219745793.svg)](http://chat.verdaccio.org/) -[![node](https://img.shields.io/node/v/verdaccio/latest.svg)](https://www.npmjs.com/package/verdaccio) +[![node](https://img.shields.io/node/v/@verdaccio/ui-theme/latest.svg)](https://www.npmjs.com/package/verdaccio) ![MIT](https://img.shields.io/github/license/mashape/apistatus.svg) [![Crowdin](https://d322cqt584bo4o.cloudfront.net/verdaccio/localized.svg)](https://crowdin.com/project/verdaccio) @@ -30,11 +19,27 @@ 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) -🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧 +## Contributing -**This is a maintenance branch, only bug fixing, minor changes or security updates** +We use `>=yarn@1.13.0`, keep on mind we use lock file. + +For development run the following command, it will execute `webpack` and `verdaccio` to + +``` +yarn dev +``` +The configuration file is located on `tools/_config.yaml`. + +Run lintings and test to check your code is clean. + +``` +yarn lint && yarn test +``` + +Remember we follow the [the Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0-beta.4/). + +🤓 Feel free to participate in code reviews, let us know if you want to participate in this plugin. -🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧 ## Open Collective Sponsors @@ -63,7 +68,7 @@ This project exists thanks to all the people who contribute. [[Contribute](CONTR [![contrubitors](https://opencollective.com/verdaccio/contributors.svg?width=890&button=true)](../../graphs/contributors) -### FAQ / Contact / Troubleshoot +### FAQ / Contact / Troubleshoot If you have any issue you can try the following options, do no desist to ask or check our issues database, perhaps someone has asked already what you are looking for.