forked from sombochea/verdaccio-ui
chore: update readme
This commit is contained in:
parent
3506f32ad8
commit
ae842cd001
83
README.md
83
README.md
@ -1 +1,82 @@
|
|||||||
under construction...
|
|
||||||
|
![verdaccio gif](https://user-images.githubusercontent.com/558752/52916111-fa4ba980-32db-11e9-8a64-f4e06eb920b3.png)
|
||||||
|
|
||||||
|
# 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 (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)
|
||||||
|
[![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)
|
||||||
|
![MIT](https://img.shields.io/github/license/mashape/apistatus.svg)
|
||||||
|
[![Crowdin](https://d322cqt584bo4o.cloudfront.net/verdaccio/localized.svg)](https://crowdin.com/project/verdaccio)
|
||||||
|
|
||||||
|
|
||||||
|
[![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)
|
||||||
|
|
||||||
|
π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§
|
||||||
|
|
||||||
|
**This is a maintenance branch, only bug fixing, minor changes or security updates**.
|
||||||
|
|
||||||
|
π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§π§
|
||||||
|
|
||||||
|
## Open Collective Sponsors
|
||||||
|
|
||||||
|
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/verdaccio#sponsor)]
|
||||||
|
|
||||||
|
[![sponsor](https://opencollective.com/verdaccio/sponsor/0/avatar.svg)](https://opencollective.com/verdaccio/sponsor/0/website)
|
||||||
|
[![sponsor](https://opencollective.com/verdaccio/sponsor/1/avatar.svg)](https://opencollective.com/verdaccio/sponsor/1/website)
|
||||||
|
[![sponsor](https://opencollective.com/verdaccio/sponsor/2/avatar.svg)](https://opencollective.com/verdaccio/sponsor/2/website)
|
||||||
|
[![sponsor](https://opencollective.com/verdaccio/sponsor/3/avatar.svg)](https://opencollective.com/verdaccio/sponsor/3/website)
|
||||||
|
[![sponsor](https://opencollective.com/verdaccio/sponsor/4/avatar.svg)](https://opencollective.com/verdaccio/sponsor/4/website)
|
||||||
|
[![sponsor](https://opencollective.com/verdaccio/sponsor/5/avatar.svg)](https://opencollective.com/verdaccio/sponsor/5/website)
|
||||||
|
[![sponsor](https://opencollective.com/verdaccio/sponsor/6/avatar.svg)](https://opencollective.com/verdaccio/sponsor/6/website)
|
||||||
|
[![sponsor](https://opencollective.com/verdaccio/sponsor/7/avatar.svg)](https://opencollective.com/verdaccio/sponsor/7/website)
|
||||||
|
[![sponsor](https://opencollective.com/verdaccio/sponsor/8/avatar.svg)](https://opencollective.com/verdaccio/sponsor/8/website)
|
||||||
|
[![sponsor](https://opencollective.com/verdaccio/sponsor/9/avatar.svg)](https://opencollective.com/verdaccio/sponsor/9/website)
|
||||||
|
|
||||||
|
## Open Collective Backers
|
||||||
|
|
||||||
|
Thank you to all our backers! π [[Become a backer](https://opencollective.com/verdaccio#backer)]
|
||||||
|
|
||||||
|
[![backers](https://opencollective.com/verdaccio/backers.svg?width=890)](https://opencollective.com/verdaccio#backers)
|
||||||
|
|
||||||
|
## Contributors
|
||||||
|
|
||||||
|
This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
|
||||||
|
|
||||||
|
[![contrubitors](https://opencollective.com/verdaccio/contributors.svg?width=890&button=true)](../../graphs/contributors)
|
||||||
|
|
||||||
|
### 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.
|
||||||
|
|
||||||
|
* [Blog](https://medium.com/verdaccio)
|
||||||
|
* [Donations](https://opencollective.com/verdaccio)
|
||||||
|
* [Roadmaps](https://github.com/verdaccio/verdaccio/projects)
|
||||||
|
* [Reporting an issue](https://github.com/verdaccio/verdaccio/blob/master/CONTRIBUTING.md#reporting-a-bug)
|
||||||
|
* [Running discussions](https://github.com/verdaccio/verdaccio/issues?q=is%3Aissue+is%3Aopen+label%3Adiscuss)
|
||||||
|
* [Chat](http://chat.verdaccio.org/)
|
||||||
|
* [Logos](https://verdaccio.org/docs/en/logo)
|
||||||
|
* [FAQ](https://github.com/verdaccio/verdaccio/issues?utf8=%E2%9C%93&q=is%3Aissue%20label%3Aquestion%20)
|
||||||
|
* [Docker Examples](https://github.com/verdaccio/docker-examples)
|
||||||
|
|
||||||
|
### License
|
||||||
|
|
||||||
|
Verdaccio is [MIT licensed](https://github.com/verdaccio/verdaccio/blob/master/LICENSE)
|
Loadingβ¦
Reference in New Issue
Block a user