mirror of
https://github.com/verdaccio/verdaccio.git
synced 2024-12-30 22:34:10 -05:00
docs: fix typos in readme (#4506)
This commit is contained in:
parent
8ace3245ff
commit
e4e1171af8
1 changed files with 20 additions and 20 deletions
40
README.md
40
README.md
|
@ -87,7 +87,7 @@ Learn more [here](https://verdaccio.org/docs/dev-plugins) how to develop plugins
|
||||||
|
|
||||||
## Donations
|
## 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, consider do a long support donation - **and your logo will be on this section of the readme.**
|
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, consider doing a long support donation - **and your logo will be on this section of the readme.**
|
||||||
|
|
||||||
**[Donate](https://github.com/sponsors/verdaccio)** 💵👍🏻 starting from _$1/month_ or just one single contribution.
|
**[Donate](https://github.com/sponsors/verdaccio)** 💵👍🏻 starting from _$1/month_ or just one single contribution.
|
||||||
|
|
||||||
|
@ -113,7 +113,7 @@ If you want to use a modified version of some 3rd-party package (for example, yo
|
||||||
### E2E Testing
|
### E2E Testing
|
||||||
|
|
||||||
Verdaccio has proved to be a lightweight registry that can be
|
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**, **babel.js**, **angular-cli** or **docusaurus**. You can read more in [here](https://verdaccio.org/docs/e2e).
|
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).
|
||||||
|
|
||||||
Furthermore, here few examples how to start:
|
Furthermore, here few examples how to start:
|
||||||
|
|
||||||
|
@ -200,7 +200,7 @@ docker pull verdaccio/verdaccio:nightly-master
|
||||||
|
|
||||||
Available as [tags](https://hub.docker.com/r/verdaccio/verdaccio/tags/).
|
Available as [tags](https://hub.docker.com/r/verdaccio/verdaccio/tags/).
|
||||||
|
|
||||||
### Running verdaccio using Docker
|
### Running Verdaccio using Docker
|
||||||
|
|
||||||
To run the docker container:
|
To run the docker container:
|
||||||
|
|
||||||
|
@ -212,35 +212,35 @@ Docker examples are available [in this repository](https://github.com/verdaccio/
|
||||||
|
|
||||||
## Compatibility
|
## Compatibility
|
||||||
|
|
||||||
Verdaccio aims to support all features of a standard npm client that make sense to support in private repository. Unfortunately, it isn't always possible.
|
Verdaccio aims to support all features of a standard npm client that make sense to support in a private repository. Unfortunately, it isn't always possible.
|
||||||
|
|
||||||
### Basic features
|
### Basic features
|
||||||
|
|
||||||
- Installing packages (npm install, npm upgrade, etc.) - **supported**
|
- Installing packages (`npm install`, `npm update`, etc.) - **supported**
|
||||||
- Publishing packages (npm publish) - **supported**
|
- Publishing packages (`npm publish`) - **supported**
|
||||||
|
|
||||||
### Advanced package control
|
### Advanced package control
|
||||||
|
|
||||||
- Unpublishing packages (npm unpublish) - **supported**
|
- Unpublishing packages (`npm unpublish`) - **supported**
|
||||||
- Tagging (npm tag) - **supported**
|
- Tagging (`npm dist-tag`) - **supported**
|
||||||
- Deprecation (npm deprecate) - **supported**
|
- Deprecation (`npm deprecate`) - **supported**
|
||||||
|
|
||||||
### User management
|
### User management
|
||||||
|
|
||||||
- Registering new users (npm adduser {newuser}) - **supported**
|
- Registering new users (`npm adduser {newuser}`) - **supported**
|
||||||
- Change password (npm profile set password) - **supported**
|
- Change password (`npm profile set password`) - **supported**
|
||||||
- Transferring ownership (npm owner add {user} {pkg}) - not supported, _PR-welcome_
|
- Transferring ownership (`npm owner add {user} {pkg}`) - not supported, _PR-welcome_
|
||||||
- Token (npm token) - **supported**
|
- Token (`npm token`) - **supported**
|
||||||
|
|
||||||
### Miscellany
|
### Miscellaneous
|
||||||
|
|
||||||
- Searching (npm search) - **supported** (cli / browser)
|
- Searching (`npm search`) - **supported** (cli / browser)
|
||||||
- Ping (npm ping) - **supported**
|
- Ping (`npm ping`) - **supported**
|
||||||
- Starring (npm star, npm unstar, npm stars) - **supported**
|
- Starring (`npm star`, `npm unstar`, `npm stars`) - **supported**
|
||||||
|
|
||||||
### Security
|
### Security
|
||||||
|
|
||||||
- npm/yarn audit - **supported**
|
- Audit (`npm/yarn audit`) - **supported**
|
||||||
|
|
||||||
## Report a vulnerability
|
## Report a vulnerability
|
||||||
|
|
||||||
|
@ -269,7 +269,7 @@ Thanks to the following companies to help us to achieve our goals providing free
|
||||||
| ![priscilawebdev](https://avatars2.githubusercontent.com/u/29228205?s=120&v=4) | ![DanielRuf](https://avatars3.githubusercontent.com/u/827205?s=120&v=4) |
|
| ![priscilawebdev](https://avatars2.githubusercontent.com/u/29228205?s=120&v=4) | ![DanielRuf](https://avatars3.githubusercontent.com/u/827205?s=120&v=4) |
|
||||||
| [@priscilawebdev](https://twitter.com/priscilawebdev) | [@DanielRufde](https://twitter.com/DanielRufde) |
|
| [@priscilawebdev](https://twitter.com/priscilawebdev) | [@DanielRufde](https://twitter.com/DanielRufde) |
|
||||||
|
|
||||||
You can find and chat with then over Discord, click [here](http://chat.verdaccio.org) or follow them at _Twitter_.
|
You can find and chat with them over Discord, click [here](http://chat.verdaccio.org) or follow them at _Twitter_.
|
||||||
|
|
||||||
## Who is using Verdaccio?
|
## Who is using Verdaccio?
|
||||||
|
|
||||||
|
@ -323,7 +323,7 @@ This project exists thanks to all the people who contribute. [[Contribute](CONTR
|
||||||
|
|
||||||
### 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.
|
If you have any issue you can try the following options. Do no hesitate to ask or check our issues database. Perhaps someone has asked already what you are looking for.
|
||||||
|
|
||||||
- [Blog](https://verdaccio.org/blog/)
|
- [Blog](https://verdaccio.org/blog/)
|
||||||
- [Donations](https://github.com/sponsors/verdaccio)
|
- [Donations](https://github.com/sponsors/verdaccio)
|
||||||
|
|
Loading…
Reference in a new issue