Merge pull request #63 from eugenezinovyev/maintenance/readme-update

Readme update

Author: eugenezinovyev

README.md

@@ -3,34 +3,57 @@
 
 # LCOV viewer
 
+Live: **[lcov-viewer.netlify.app](https://lcov-viewer.netlify.app/)**
+
 LCOV code coverage report viewer. Parses lcov report files and generates HTML report grouped by directory.
 
-## Installation
+This repository provides two packages:
 
-This repository uses Yarn workspaces. Please use Yarn as a package manager.
+| Package                                                                                                                                   | Description                                                                        |
+|-------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------|
+| [![npm version](https://badge.fury.io/js/@lcov-viewer%2Fistanbul-report.svg)](https://www.npmjs.com/package/@lcov-viewer/istanbul-report) | Istanbul grouped HTML report. Generates code coverage report grouped by directory. |
+| [![npm version](https://badge.fury.io/js/@lcov-viewer%2Fcli.svg)](https://www.npmjs.com/package/@lcov-viewer/cli)                         | CLI to convert coverage in LCOV format to a grouped HTML report.                   |
 
-```
-> git clone https://github.com/eugenezinovyev/lcov-viewer.git
-> cd lcov-viewer
-> yarn
-> cd packages/app
-> yarn start
+## Istanbul Report
+
+Istanbul reporter for Jest and nyc. Generates code coverage report grouped by directory.
+
+Documentation: [/packages/istanbul-report](/packages/istanbul-report)
+
+```shell
+yarn add -D @lcov-viewer/istanbul-report
+npm install -D @lcov-viewer/istanbul-report
 ```
 
-## Istanbul report
+## CLI
 
-The repository provides Istanbul report generator.
+CLI to convert coverage in LCOV format to a grouped HTML report.
+
+Documentation: [/packages/cli](/packages/cli)
+
+```shell
+yarn global add @lcov-viewer/cli
+npm install -g @lcov-viewer/cli
 ```
-yarn add -D @lcov-viewer/istanbul-report
+
+-- OR locally in your project --
+
+```shell
+yarn add -D @lcov-viewer/cli
+npm install -D @lcov-viewer/cli
 ```
-Check documentation [here](/packages/istanbul-report).
 
-## Live Demo
+## Local Development Setup
 
-Check live demo [here](https://lcov-viewer.netlify.app/).
+This repository uses Yarn workspaces. Please use Yarn as a package manager.
 
-## Demo
+```shell
+git clone https://github.com/eugenezinovyev/lcov-viewer.git
+cd lcov-viewer
+yarn
+yarn start
+```
 
-Open LCOV viewer in your browser and drop `lcov.info` file into the dropzone.
+The open http://localhost:8080/ in your browser and drop `lcov.info` file into the dropzone.
 
 ![viewer](https://user-images.githubusercontent.com/1678896/139163904-5f845791-2af5-4cdd-b044-98406b2963b7.gif)

package.json

@@ -14,7 +14,8 @@
     "test": "lerna run test --stream",
     "test:all": "jest --colors --passWithNoTests",
     "version:update": "lerna version --no-push",
-    "syncpack": "syncpack list-mismatches"
+    "syncpack": "syncpack list-mismatches",
+    "start" : "lerna run start --scope @lcov-viewer/app --stream"
   },
   "devDependencies": {
     "@babel/core": "^7.18.6",