Update issue templates and README

Author: eugenezinovyev

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

README.md

@@ -0,0 +1,30 @@
+# LCOV viewer
+
+Parses LCOV file and generates coverage tree view.
+
+## Installation
+
+This repository uses Yarn workspaces. Please use Yarn to 
+
+```
+> git clone https://github.com/eugenezinovyev/lcov-viewer.git
+> cd lcov-viewer
+> yarn
+> cd packages/app
+> yarn start
+```
+
+## Istanbul report
+
+The repository provides Istanbul report generator.
+```
+yarn add -D @lcov-viewer/istanbul-report~~~~
+```
+Please see docs [here](/packages/istanbul-report).
+
+## Example
+
+Open LCOV viewer in your browser and drop `lcov.info` file into the dropzone.
+
+![image](https://user-images.githubusercontent.com/1678896/138569019-dba539b2-bc32-4bc0-8573-051e2fef64f4.png)
+![image](https://user-images.githubusercontent.com/1678896/138568915-ed3d5afb-c1a8-4a9a-a986-2d23a0ae447f.png)

package.json

@@ -1,5 +1,6 @@
 {
   "name": "lcov-viewer",
+  "description": "LCOV viewer",
   "version": "1.0.0",
   "author": "Eugene Zinovyev <[email protected]>",
   "license": "MIT",
@@ -45,5 +46,10 @@
     "webpack-bundle-analyzer": "^4.5.0",
     "webpack-cli": "^4.9.1",
     "webpack-dev-server": "^4.3.1"
+  },
+  "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/eugenezinovyev/lcov-viewer.git"
   }
 }

packages/istanbul-report/README.md

@@ -0,0 +1,27 @@
+# LCOV viewer Istanbul report
+
+Generates coverage report 
+
+## Install
+
+Install development dependency using NPM
+```
+npm install -D @lcov-viewer/istanbul-report
+```
+OR using YARN
+```
+yarn add -D @lcov-viewer/istanbul-report
+```
+Update your Jest config
+```js
+module.exports = {
+    // ...
+    coverageReporters: [
+        '@lcov-viewer/istanbul-report'
+    ],
+    // ...
+};
+```
+
+## Demo
+![image](https://user-images.githubusercontent.com/1678896/138568915-ed3d5afb-c1a8-4a9a-a986-2d23a0ae447f.png)

packages/istanbul-report/package.json

@@ -24,5 +24,14 @@
   },
   "files": [
     "lib/**/*.*"
-  ]
+  ],
+  "directories": {
+    "lib": "lib"
+  },
+  "description": "An Istanbul report to generate LCOV viewer report.",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/eugenezinovyev/lcov-viewer.git",
+    "directory": "packages/istanbul-report"
+  }
 }