From b29de5c8fdb04496c8fe519a2613410c8cef3adf Mon Sep 17 00:00:00 2001 From: "Juan Picado @jotadeveloper" Date: Tue, 29 Aug 2017 07:52:43 +0200 Subject: [PATCH] docs: Add installation section --- wiki/install.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 wiki/install.md diff --git a/wiki/install.md b/wiki/install.md new file mode 100644 index 000000000..9634ed36d --- /dev/null +++ b/wiki/install.md @@ -0,0 +1,42 @@ +# Installation + +Verdaccio is a multiplatform web application, to install you need at least some prerequisites. + +#### Prerequisites + +* Node higher than **4.6.1** +* npm or yarn + + +## Installing the CLI + +`Verdaccio` must be install globaly using any of the most modern + +Using `npm` + +```bash +npm install -g npm + +``` +or using `yarn` + +```bash +yarn global add verdaccio + +``` + +## Basic Usage + +Once has been installed you only need to execute the CLI command. + +```bash +$> verdaccio +``` + +![](https://cdn-images-1.medium.com/max/720/1*jDHnZ7_68u5s1lFK2cygnA.gif) + +For more information about CLI please [read the cli section](cli.md). + +## 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).