From f3e08b5aa40fcda1bc7502e7335dbd2661b63db3 Mon Sep 17 00:00:00 2001 From: Alexey Kasyanchuk Date: Wed, 14 Jul 2021 15:10:51 +0300 Subject: [PATCH] doc(README): add desktop section --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 16e57a2..dac0486 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,20 @@ We are welcome any contributing: bug fixes, improvements, code refactoring and o * [English](docs/USAGE.md) * [Russian](docs/USAGE.RU.md) +## Download Desktop client +By default we recomended using desktop version of application. [Download and install most recent one](https://github.com/DEgITx/rats-search/releases) for Windows, MacOS, Linux. + +### Start desktop client from master branch +Clone repository, then make sure that you have Node.js and NPM (with Node.js) installed in your system, then install all needed packages: + +```bash +npm install +``` +and start master develop branch version: +```bash +npm start +``` + ## Server webUI version installation Beside default desktop cross-platform client, also exist separated webUI that can run from server independant as web-client + Node.JS server.