1
0
mirror of https://github.com/verdaccio/verdaccio.git synced 2024-11-08 23:25:51 +01:00

Improve grammar and wording in docs/install.md

This commit is contained in:
Nicholas Farley 2018-03-15 13:57:42 -04:00 committed by GitHub
parent 484e2a6afe
commit 5e720b4511
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -3,19 +3,19 @@ id: installation
title: "Installation" title: "Installation"
--- ---
Verdaccio is a multiplatform web application, to install you need at least some prerequisites. Verdaccio is a multiplatform web application. To install it, you need a few prerequisites.
#### Prerequisites #### Prerequisites
1. Node higher than 1. Node higher than
- For version `verdaccio@2.x` we support from Node `v4.6.1`. - For version `verdaccio@2.x` Node `v4.6.1` is the minimum supported version.
- For version `verdaccio@3.x` we support as minimum Node `6.12.0` - For version `verdaccio@3.x` Node `6.12.0` is the minimum supported version.
2. npm `>=3.x` or `yarn` 2. npm `>=3.x` or `yarn`
3. The web interface support browsers `Chrome, Firefox, Edge, and IE9` 3. The web interface supports the `Chrome, Firefox, Edge, and IE9` browsers.
## Installing the CLI ## Installing the CLI
`verdaccio` must be install globaly using any of the most modern `verdaccio` must be installed globaly using either of the following methods:
Using `npm` Using `npm`
@ -30,7 +30,7 @@ yarn global add verdaccio
## Basic Usage ## Basic Usage
Once has been installed you only need to execute the CLI command. Once it has been installed, you only need to execute the CLI command:
```bash ```bash
$> verdaccio $> verdaccio
@ -40,8 +40,8 @@ warn --- http address - http://localhost:5555/ - verdaccio/3.0.0
![](https://cdn-images-1.medium.com/max/720/1*jDHnZ7_68u5s1lFK2cygnA.gif) ![](https://cdn-images-1.medium.com/max/720/1*jDHnZ7_68u5s1lFK2cygnA.gif)
For more information about CLI please [read the cli section](cli.md). For more information about the CLI, please [read the cli section](cli.md).
## Docker Image ## Docker Image
`verdaccio` has a official docker image you can use, in the most of cases is good enough just the default configuration, for more information about how to install the official image [read the docker section](docker.md). `verdaccio` has an official docker image you can use, and in most cases, the default configuration is good enough. For more information about how to install the official image, [read the docker section](docker.md).