From 15412712e1fbb30426e54c44a3ec25c49c52ba59 Mon Sep 17 00:00:00 2001 From: NGPixel Date: Sat, 29 Apr 2017 01:15:25 -0400 Subject: [PATCH] docs: Updated npm readme [ci skip] --- npm/README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/npm/README.md b/npm/README.md index cd94522b..d4dda9c3 100644 --- a/npm/README.md +++ b/npm/README.md @@ -1,6 +1,4 @@ - - Wiki.js - +![Wiki.js](https://raw.githubusercontent.com/Requarks/wiki-site/1.0/assets/images/logo.png) # Wiki.js @@ -8,19 +6,21 @@ [![Release](https://img.shields.io/github/release/Requarks/wiki.svg?style=flat-square&maxAge=3600)](https://github.com/Requarks/wiki/releases) [![License](https://img.shields.io/badge/license-AGPLv3-blue.svg?style=flat-square)](https://github.com/requarks/wiki/blob/master/LICENSE) -This npm package is an installer for Wiki.js. For information about Wiki.js, including detailed installation steps, read the following links: +This npm package is an installer for Wiki.js. +For information about Wiki.js, including detailed installation steps, read the following links: -- [Official Website](https://wiki.requarks.io/) -- [Installation Guide](https://wiki.requarks.io/get-started.html) +- [Official Website](https://wiki.js.org/) +- [Installation Guide](https://wiki.js.org/get-started.html) - [GitHub Repository](https://github.com/Requarks/wiki) ### Install Wiki.js -1. Create an empty folder where Wiki.js will run. -2. Launch a terminal / command prompt inside this newly created folder. -3. Run the command: `npm install wiki.js@latest` -4. Wait for the installation process to complete. This may take several minutes. -5. You'll be prompted to run the configuration wizard to finish the installation. +1. Make sure you meet all [prerequisites](https://docs.requarks.io/wiki/prerequisites). +2. Create an empty folder where Wiki.js will run. +3. Launch a terminal / command prompt inside this newly created folder. +4. Run the command: `npm install wiki.js@latest` +5. Wait for the installation process to complete. This may take several minutes. +6. You'll be prompted to run the configuration wizard to finish the installation. The configuration wizard can also be run manually using: `node wiki configure [port]` To start Wiki.js manually, run the command: `node wiki start`