Skip to content

Commit 12da966

Browse files
committed
chore: update readme
1 parent 4ee6c2d commit 12da966

File tree

1 file changed

+25
-20
lines changed

1 file changed

+25
-20
lines changed

β€ŽREADME.md

+25-20
Original file line numberDiff line numberDiff line change
@@ -3,38 +3,43 @@
33

44
# Version 4 UI Theme
55

6-
[Verdaccio](https://verdaccio.org/) is a simple, **zero-config-required local private npm registry**.
7-
No need for an entire database just to get started! Verdaccio comes out of the box with
8-
**its own tiny database**, and the ability to proxy other registries (eg. npmjs.org),
9-
caching the downloaded modules along the way.
10-
For those looking to extend their storage capabilities, Verdaccio
11-
**supports various community-made plugins to hook into services such as Amazon's s3,
12-
Google Cloud Storage** or create your own plugin.
13-
14-
15-
[![verdaccio (latest)](https://img.shields.io/npm/v/verdaccio/latest.svg)](https://www.npmjs.com/package/verdaccio)
16-
[![verdaccio (next)](https://img.shields.io/npm/v/verdaccio/next.svg)](https://www.npmjs.com/package/verdaccio)
17-
[![verdaccio (next)](http://img.shields.io/npm/dy/verdaccio.svg)](https://www.npmjs.com/package/verdaccio)
6+
[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.
7+
8+
9+
[![verdaccio (latest)](https://img.shields.io/npm/v/@verdaccio/ui-theme/latest.svg)](https://www.npmjs.com/package/verdaccio)
1810
[![docker pulls](https://img.shields.io/docker/pulls/verdaccio/verdaccio.svg?maxAge=43200)](https://verdaccio.org/docs/en/docker.html)
1911
[![backers](https://opencollective.com/verdaccio/tiers/backer/badge.svg?label=Backer&color=brightgreen)](https://opencollective.com/verdaccio)
2012
[![stackshare](https://img.shields.io/badge/Follow%20on-StackShare-blue.svg?logo=stackshare&style=flat)](https://stackshare.io/verdaccio)
21-
22-
![circle ci status](https://circleci.com/gh/verdaccio/verdaccio.svg?style=shield&circle-token=:circle-token)
23-
[![codecov](https://img.shields.io/codecov/c/github/verdaccio/verdaccio/master.svg)](https://codecov.io/gh/verdaccio/verdaccio)
2413
[![discord](https://img.shields.io/discord/388674437219745793.svg)](http://chat.verdaccio.org/)
25-
[![node](https://img.shields.io/node/v/verdaccio/latest.svg)](https://www.npmjs.com/package/verdaccio)
14+
[![node](https://img.shields.io/node/v/@verdaccio/ui-theme/latest.svg)](https://www.npmjs.com/package/verdaccio)
2615
![MIT](https://img.shields.io/github/license/mashape/apistatus.svg)
2716
[![Crowdin](https://d322cqt584bo4o.cloudfront.net/verdaccio/localized.svg)](https://crowdin.com/project/verdaccio)
2817

2918

3019
[![Twitter followers](https://img.shields.io/twitter/follow/verdaccio_npm.svg?style=social&label=Follow)](https://twitter.com/verdaccio_npm)
3120
[![Github](https://img.shields.io/github/stars/verdaccio/verdaccio.svg?style=social&label=Stars)](https://github.com/verdaccio/verdaccio/stargazers)
3221

33-
🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧
22+
## Contributing
23+
24+
We use `>[email protected]`, keep on mind we use lock file.
25+
26+
For development run the following command, it will execute `webpack` and `verdaccio` to
27+
28+
```
29+
yarn dev
30+
```
31+
The configuration file is located on `tools/_config.yaml`.
32+
33+
Run lintings and test to check your code is clean.
34+
35+
```
36+
yarn lint && yarn test
37+
```
38+
39+
Remember we follow the [the Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0-beta.4/).
3440

35-
**This is a maintenance branch, only bug fixing, minor changes or security updates**
41+
πŸ€“ Feel free to participate in code reviews, let us know if you want to participate in this plugin.
3642

37-
🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧
3843

3944
## Open Collective Sponsors
4045

@@ -63,7 +68,7 @@ This project exists thanks to all the people who contribute. [[Contribute](CONTR
6368

6469
[![contrubitors](https://opencollective.com/verdaccio/contributors.svg?width=890&button=true)](../../graphs/contributors)
6570

66-
### FAQ / Contact / Troubleshoot
71+
### FAQ / Contact / Troubleshoot
6772

6873
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.
6974

0 commit comments

Comments
Β (0)