update readme

README.md

@@ -3,36 +3,76 @@
 ![release all os -- no code signing](https://github.com/pavlobu/deskreen/workflows/release%20all%20os%20--%20no%20code%20signing/badge.svg)
 ![codecov generate](https://github.com/pavlobu/deskreen/workflows/codecov%20generate/badge.svg)
 
-## Howto:
+# Deskreen
 
-# trigger
+### Website: https://www.deskreen.com
 
-### to generate test coverage results
+## Deskreen turns any device with a web browser to a second screen for your computer
 
-```
+Deskreen is an `electron.js` based application that uses `WebRTC` to make a live stream of your
-yarn coverage
+desktop to a web browser on any device.
-```
+It is built on top of [Electron React Boilerplate](https://github.com/electron-react-boilerplate)
+For better security mechanism, end-to-end encrytpion is implemented, which is inspired by
+[darkwire.io](https://github.com/darkwire/darkwire.io) , the difference is, that it is rewritten
+in `Typescript` and trnasformed to use `node-forge` instead of `window.crypto.subtle`.
+Why this was made? Because a client served with `http` without SSL, which makes `window.crypto. subtle` unavailable.
+(TODO: write more docs about Deskreen architecture)
 
-### to run sonarqube scanner to put results to sonarqube
+## Get Started for Developers
 
-```
+### Prerequisites
-sonar-scanner
-```
 
-### sonar-project.properties example:
+You will need to have `node` `npm` and `yarn` installed
+globally on your machine.
 
-```
+1. git clone this repo
-sonar.projectKey=test-electron-react-boilerplate
+2. `yarn install`
-# sonar.testExecutionReportPaths=test-reporter.xml
+3. `yarn dev` -- run in dev mode with live updates
-sonar.testExecutionReportPaths=test-reports/test-reporter.xml
-sonar.typescript.lcov.reportPaths=coverage/lcov.info
-sonar.sources=./app
-sonar.tests=./test
-sonar.host.url=http://localhost:9000
-sonar.login=d0c254aaff5ebd89dd5c6f0663238ab6ad5fddea
-# sonar.login=039884f95817f7b26d781d7cdd47430cb3734a0a
 
-```
+### Useful yarn commands
+
+`yarn start` -- run in production mode to test, without packaging
+`yarn package` -- to package an app and make executables available in `release` folder
+
+#### for more yarn commands look at `package.json`
+
+### How to run tests
+
+`yarn test` -- run all unit tests
+`yarn build-ux && yarn test-ux` -- run User Experience tests (no tests for `app/client` yet)
+
+### TODO: add e2e tests with host + client app interaction
+
+#### run tests of host app
+
+`yarn test-watch-not-silent` -- run tests in watch mode with console logs only for host app, excluding `app/client`
+`yarn test -- -u` -- update snapshots
+
+#### run tests for `app/client`
+
+`yarn test` -- run client tests in watch mode
+`test:nowatch` -- run client tests a single time
+`yarn test -- -u` -- update snapshots
+
+### Generate test coverage results
+
+`yarn coverage` -- when run from project root, generates a coverage report for `host` and `app/client`
+
+## Instruction for running a local Sonar Qube, community edition
+
+### Prerequisites
+
+You need to install Sonar Qube community edition for your machine.
+And sonar-scanner. Then add sonar scanner to your PATH.
+
+You need to run sonar-scanner separately on root directory
+and on `app/client` directory.
+
+Luckily for you sonar scanner is automatically triggered after `husky` checks.
+So you only need to install and configure SonarCube locally and
+create two separate projects in SonarCube panel.
+First project for host app, and second project for client viewer app.
+TODO: add how to get started with local SonarCube for Deskreen in details.
 
 ## Maintainer
 
@@ -40,14 +80,13 @@ sonar.login=d0c254aaff5ebd89dd5c6f0663238ab6ad5fddea
 
 ## License
 
-MIT © [Pavlo (Paul) Buidenkov](https://github.com/pavlobu/deskreen)
+AGPL-3.0 License © [Pavlo (Paul) Buidenkov](https://github.com/pavlobu/deskreen)
 
 ## Copyright
 
 MIT © [Electron React Boilerplate](https://github.com/electron-react-boilerplate)
+Deskreen Logo PNG Image -- © [Nadiia Plaunova](https://www.artstation.com/nadiiia)
 
-## Test ?
+## Donate
 
-## By
+Click to donate on Deskreen's Patreon page: [DONATE!](https://github.com/electron-react-boilerplate)
-
-Crafted with LOVE and support from Pavlo (Paul) Buidenkov