inspector.js - npm Package Compare versions

Comparing version 1.0.2 to 1.0.3

package.json

 {
   "name": "inspector.js",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Javascript Library that implements MpegTS and MP4 demuxers.",
-  "repository" : {
-    "type" : "git",
-    "url" : "https://github.com/epiclabs-io/inspector.js"
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/epiclabs-io/inspector.js"
   },
@@ -24,7 +24,2 @@ "main": "./lib/inspector-lib.min.js",
   "devDependencies": {
-    "@types/angular": "^1.6.28",
-    "@types/bootstrap": "^3.3.35",
-    "@types/hls.js": "^0.7.4",
-    "angular": "^1.6.5",
-    "angular-tree-control": "^0.2.28",
     "awesome-typescript-loader": "^3.2.1",
@@ -34,7 +29,5 @@ "babel-core": "^6.25.0",
     "babel-preset-es2015": "^6.24.1",
-    "bootstrap": "^3.3.7",
     "chai": "^4.1.1",
     "css-loader": "^0.28.4",
     "extract-text-webpack-plugin": "^2.1.2",
-    "html-webpack-externals-plugin": "^3.4.0",
     "html-webpack-plugin": "^2.29.0",
@@ -41,0 +34,0 @@ "mocha": "^3.5.0",

README.md

@@ -11,12 +11,34 @@ Travis CI Status: [![Travis CI Status](https://travis-ci.org/epiclabs-io/inspector.js.svg?branch=master)](https://travis-ci.org/epiclabs-io/inspector.js)
 
-### How do I get set up? ###
+Note: Inspector.js can be used with web workers which allows to inspect big files without blocking UI. Take a look to our samples to see how to use it.
 
-* npm install
-* npm run build
+### Quick Start ###
+The easiest way to start using inspector.js in your own projects is installing it using npm:
+* npm install inspector.js
 
+Once done, and integrated with your web app, you can start using it. Example:
+```javascript
+    var mediaSamplesUrl = 'https://video-dev.github.io/streams/x36xhzz/url_0/url_462/193039199_mp4_h264_aac_hd_7.ts';
+    var req = new XMLHttpRequest();
+    req.open('GET', mediaSamplesUrl, true);
+    req.responseType = 'arraybuffer';
+
+    req.onload = function (data) {
+    var arrayBuffer = req.response;
+    if (arrayBuffer) {
+        var byteArray = new Uint8Array(arrayBuffer);
+        var demuxer = inspectorjs.createMpegTSDemuxer();
+        demuxer.append(byteArray);
+        demuxer.end();
+
+        // You will find tracks information in demuxer.tracks
+        console.log(demuxer.tracks);
+    }
+```
+
 ### Development guidelines ###
+* Install dependencies
+  * npm install
+* Run devevelopment server
+  * npm run start
 
-* npm install
-* npm run start
-
-Once dev server is started, project is automatically built and compiled whenever you apply any change.
+Once dev server gets started, the project is automatically built whenever you apply any change.

webpack.config.js

 const path = require("path");
 const webpack = require("webpack");
 const HtmlWebpackPlugin = require('html-webpack-plugin');
-const HtmlWebpackExternalsPlugin = require('html-webpack-externals-plugin')
 
@@ -55,25 +54,6 @@ const PATHS = {
         }),
-        new HtmlWebpackExternalsPlugin({
-            outputPath: 'samples/vendors',
-            publicPath: '../',
-            externals: [
-                {
-                    module: 'bootstrap',
-                    entry: 'dist/css/bootstrap.min.css',
-                },
-                {
-                    module: 'angular',
-                    entry: 'angular.min.js',
-                    global: 'angular',
-                },
-                {
-                    module: 'angular-tree-control',
-                    entry: [
-                        'css/tree-control.css',
-                        'css/tree-control-attribute.css',
-                        'angular-tree-control.js'
-                    ],
-                    supplements: ['fonts/', 'images/'],
-                },
-            ],
+        new HtmlWebpackPlugin({
+            inject: 'head',
+            filename: 'samples/index_webworkers.html',
+            template: 'samples/index_webworkers.html'
         })
@@ -80,0 +60,0 @@ ],

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Dev dependency count

19

decreased by-26.92%

Number of lines in readme file

44

increased by100%

Worsened metrics

Total package byte prevSize

1002763

decreased by-23.05%

Lines of code

5504

decreased by-62.77%

No dependency changes