From 2bcb9bcca129435a2c84b107e1aba6db7bfac0d4 Mon Sep 17 00:00:00 2001 From: Pavel Djundik Date: Fri, 19 Jan 2018 12:51:06 +0200 Subject: [PATCH] Update readme to suggest using yarn --- README.md | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 9bc656ed..d09bfdea 100644 --- a/README.md +++ b/README.md @@ -71,14 +71,21 @@ The Lounge is the official and community-managed fork of [Shout](https://github. ## Installation and usage The Lounge requires [Node.js](https://nodejs.org/) v4 or more recent. +[Yarn package manager](https://yarnpkg.com/) is also recommended *(npm will also work)*. -### Running stable releases from npm (recommended) +### Running stable releases using Yarn (recommended) Run this in a terminal to install (or upgrade) the latest stable release from -[npm](https://www.npmjs.com/): +[npm registry](https://www.npmjs.com/): ```sh -[sudo] npm install -g thelounge +[sudo] yarn global add thelounge +``` + +If you already have The Lounge installed globally, use the following command to update it: + +```sh +[sudo] yarn global upgrade thelounge ``` When installation is complete, run: @@ -100,12 +107,12 @@ The following commands install and run the development version of The Lounge: ```sh git clone https://github.com/thelounge/lounge.git cd lounge -npm install -NODE_ENV=production npm run build -npm start +yarn install +NODE_ENV=production yarn build +yarn start ``` -When installed like this, npm doesn't create a `thelounge` executable. Use `npm start -- ` to run subcommands. +When installed like this, `thelounge` executable is not created. Use `node index ` to run commands. ⚠️ While it is the most recent codebase, this is not production-ready! Run at your own risk. It is also not recommended to run this as root.