recordrtc - npm Package Compare versions

Comparing version 4.0.8 to 4.0.9

package.json

 {
   "name": "recordrtc",
-  "preferGlobal": true,
-  "version": "4.0.8",
+  "preferGlobal": false,
+  "version": "4.0.9",
   "author": {
@@ -6,0 +6,0 @@ "name": "Muaz Khan",

README.md

@@ -1,33 +0,29 @@
-## [RecordRTC](https://github.com/muaz-khan/RecordRTC): [WebRTC](https://www.webrtc-experiment.com/) audio/video recording / [Wiki Pages](https://github.com/muaz-khan/RecordRTC/wiki) / [Demo](https://www.webrtc-experiment.com/RecordRTC/) 
+# [RecordRTC](https://github.com/muaz-khan/RecordRTC): [WebRTC](https://www.webrtc-experiment.com/) audio/video recording
 
+[RecordRTC Documentation](https://RecordRTC.org/) / [RecordRTC Wiki Pages](https://github.com/muaz-khan/RecordRTC/wiki) / [RecordRTC Demo](https://www.webrtc-experiment.com/RecordRTC/) / [WebRTC Experiments](https://www.webrtc-experiment.com/)
+
 [![npm](https://img.shields.io/npm/v/recordrtc.svg)](https://npmjs.org/package/recordrtc) [![downloads](https://img.shields.io/npm/dm/recordrtc.svg)](https://npmjs.org/package/recordrtc)
 
-[RecordRTC](https://www.webrtc-experiment.com/RecordRTC/) is a server-less (entire client-side) JavaScript library can be used to record WebRTC audio/video media streams. It supports cross-browser audio/video recording.
+> [RecordRTC](https://www.webrtc-experiment.com/RecordRTC/) is a JavaScript-based media-recording library for modern web-browsers (supporting WebRTC getUserMedia API). It is optimized for different devices and browsers to bring all client-side (pluginfree) recording solutions in single place.
 
-> Documentation & Demos: http://RecordRTC.org
+1. [RecordRTC API Reference](http://RecordRTC.org/RecordRTC.html)
+2. [MRecordRTC API Reference](http://RecordRTC.org/MRecordRTC.html)
+3. [MediaStreamRecorder API Reference](http://RecordRTC.org/MediaStreamRecorder.html)
+4. [StereoRecorder API Reference](http://RecordRTC.org/StereoRecorder.html)
+5. [StereoAudioRecorder API Reference](http://RecordRTC.org/StereoAudioRecorder.html)
+6. [WhammyRecorder API Reference](http://RecordRTC.org/WhammyRecorder.html)
+7. [Whammy API Reference](http://RecordRTC.org/Whammy.html)
+8. [CanvasRecorder API Reference](http://RecordRTC.org/CanvasRecorder.html)
+9. [GifRecorder API Reference](http://RecordRTC.org/GifRecorder.html)
+10. [Global API Reference](http://RecordRTC.org/global.html)
 
-```javascript
-// Browsers Support::
-// Chrome (all versions) [ audio/video individually ]
-// Firefox ( >= 29 ) [ audio/video in single webm/mp4 container or only audio in ogg ]
-// Opera (all versions) [ same as chrome ]
-// Android (Chrome) [ only video ]
-// Android (Opera) [ only video ]
-// Android (Firefox) [ only video ]
-```
+## Browsers Support:
 
-```
-npm install recordrtc
-```
+| Browser        | Support           |
+| ------------- |-------------|
+| Firefox | [Stable](http://www.mozilla.org/en-US/firefox/new/) / [Aurora](http://www.mozilla.org/en-US/firefox/aurora/) / [Nightly](http://nightly.mozilla.org/) |
+| Google Chrome | [Stable](https://www.google.com/intl/en_uk/chrome/browser/) / [Canary](https://www.google.com/intl/en/chrome/browser/canary.html) / [Beta](https://www.google.com/intl/en/chrome/browser/beta.html) / [Dev](https://www.google.com/intl/en/chrome/browser/index.html?extra=devchannel#eula) |
+| Opera | [Stable](http://www.opera.com/) / [NEXT](http://www.opera.com/computer/next)  |
+| Android | [Chrome](https://play.google.com/store/apps/details?id=com.chrome.beta&hl=en) / [Firefox](https://play.google.com/store/apps/details?id=org.mozilla.firefox) / [Opera](https://play.google.com/store/apps/details?id=com.opera.browser) |
 
-To use it:
-
-```htm
-<script src="./node_modules/recordrtc/RecordRTC.js"></script>
-```
-
-There are some other NPM packages regarding RecordRTC:
-
-* https://www.npmjs.org/search?q=RecordRTC
-
 ## How RecordRTC encodes wav/webm?
@@ -40,3 +36,3 @@
 
-=
+## RecordRTC Demos
 
@@ -55,5 +51,14 @@ 1. [RecordRTC to Node.js](https://github.com/muaz-khan/WebRTC-Experiment/tree/master/RecordRTC/RecordRTC-to-Nodejs)
 
-=
+## How to link?
 
+```
+npm install recordrtc
+```
+
+To use it:
+
 ```html
+<script src="./node_modules/recordrtc/RecordRTC.js"></script>
+
+<!-- or -->
 <script src="http://RecordRTC.org/latest.js"></script>
@@ -68,2 +73,6 @@
 
+There are some other NPM packages regarding RecordRTC:
+
+* [https://www.npmjs.org/search?q=RecordRTC](https://www.npmjs.org/search?q=RecordRTC)
+
 ## Record audio+video in Firefox
@@ -96,3 +105,3 @@
 
-Demo: https://www.webrtc-experiment.com/RecordRTC/AudioVideo-on-Firefox.html
+Demo: [AudioVideo-on-Firefox.html](https://www.webrtc-experiment.com/RecordRTC/AudioVideo-on-Firefox.html)
 
@@ -163,6 +172,4 @@ ## Record only Audio
 
-Constraints Reference:
+* [Constraints Reference](https://chromium.googlesource.com/external/webrtc/+/master/talk/app/webrtc/mediaconstraintsinterface.cc)
 
-* https://chromium.googlesource.com/external/webrtc/+/master/talk/app/webrtc/mediaconstraintsinterface.cc
-
 ## Record Video
@@ -236,2 +243,3 @@
 <script src="//cdn.webrtc-experiment.com/screenshot.js"></script>
+
 <div id="elementToShare" style="width:100%;height:100%;background:green;"></div>
@@ -253,3 +261,3 @@ <script>
 
-See a demo: https://www.webrtc-experiment.com/RecordRTC/Canvas-Recording/
+See a demo: [/Canvas-Recording/](https://www.webrtc-experiment.com/RecordRTC/Canvas-Recording/)
 
@@ -297,3 +305,3 @@ # API Reference
 
-For [MRecordRTC](https://github.com/muaz-khan/WebRTC-Experiment/tree/master/RecordRTC/MRecordRTC); you can use word `MRecordRTC` instead of `RecordRTC`!
+For [MRecordRTC](https://RecordRTC.org/MRecordRTC.html); you can use word `MRecordRTC` instead of `RecordRTC`!
 
@@ -470,13 +478,2 @@ Another possible situation!
 
-## Browser Support
-
-[RecordRTC Demo](https://www.webrtc-experiment.com/RecordRTC/) works fine on following web-browsers:
-
-| Browser        | Support           |
-| ------------- |-------------|
-| Firefox | [Stable](http://www.mozilla.org/en-US/firefox/new/) / [Aurora](http://www.mozilla.org/en-US/firefox/aurora/) / [Nightly](http://nightly.mozilla.org/) |
-| Google Chrome | [Stable](https://www.google.com/intl/en_uk/chrome/browser/) / [Canary](https://www.google.com/intl/en/chrome/browser/canary.html) / [Beta](https://www.google.com/intl/en/chrome/browser/beta.html) / [Dev](https://www.google.com/intl/en/chrome/browser/index.html?extra=devchannel#eula) |
-| Opera | [Stable](http://www.opera.com/) / [NEXT](http://www.opera.com/computer/next)  |
-| Android | [Chrome](https://play.google.com/store/apps/details?id=com.chrome.beta&hl=en) / [Firefox](https://play.google.com/store/apps/details?id=org.mozilla.firefox) / [Opera](https://play.google.com/store/apps/details?id=com.opera.browser) |
-
 ## Credits
@@ -496,4 +493,43 @@
 
+## Contribute in Documentation
+
+```
+npm install recordrtc.org
+
+# here is how to generate HTML files
+cd .\node_modules\recordrtc.org
+
+node_modules\.bin\jsdoc node_modules\recordrtc\RecordRTC.js -d .\..\..\recordrtc.org node_modules\recordrtc\README.md -t template
+```
+
+Now you'll see a directory with name `recordrtc.org`.
+
+```
+.\..\..\recordrtc.org\index.html
+```
+
+Now, you should fork this repository:
+
+* https://github.com/muaz-khan/RecordRTC
+
+And push/pull `recordrtc.org` directory to `gh-pages`.
+
+RecordRTC is using comments format from jsdoc:
+
+* http://usejsdoc.org/
+
+E.g.
+
+```javascript
+/**
+* Description
+* @summary Summary
+* @typedef Hello
+* @example
+* var some = new Something();
+*/
+```
+
 ## License
 
 [RecordRTC.js](https://github.com/muaz-khan/RecordRTC) is released under [MIT licence](https://www.webrtc-experiment.com/licence/) . Copyright (c) [Muaz Khan](https://plus.google.com/+MuazKhan).

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

Total package byte prevSize

100167

increased by36.19%

Lines of code

2118

increased by53.81%

Number of lines in readme file

526

increased by7.35%

No dependency changes