recordrtc - npm Package Compare versions

Comparing version 4.0.9 to 5.0.0

package.json

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

README.md

@@ -484,10 +484,31 @@ # [RecordRTC](https://github.com/muaz-khan/RecordRTC): [WebRTC](https://www.webrtc-experiment.com/) audio/video recording
 
-## Contribute in Documentation
+## Contribute in [RecordRTC.org](http://RecordRTC.org)
 
+[![npm](https://img.shields.io/npm/v/recordrtc.org.svg)](https://npmjs.org/package/recordrtc.org) [![downloads](https://img.shields.io/npm/dm/recordrtc.org.svg)](https://npmjs.org/package/recordrtc.org)
+
+http://recordrtc.org/ is a documentation webpage for [RecordRTC.js](https://github.com/muaz-khan/RecordRTC). It is [open-sourced in github](https://github.com/muaz-khan/RecordRTC/tree/gh-pages) and everyone can collaborate to improve documentation.
+
+To contribute:
+
+1. You should modify `RecordRTC.js` file (aka [`latest.js`](https://github.com/muaz-khan/RecordRTC/blob/gh-pages/latest.js) file)
+2. You'll see that each function/property/method is having comments (format is chosen from http://usejsdoc.org/).
+3. Using `jsdoc` tool, you can generate documentation HTML pages from `latest.js` file
+4. You should NEVER modify HTML pages. You merely need to modify `latest.js` file for documentation.
+
+Steps to contribute:
+
+1. Modify `latest.js` file
+2. Use below NPM-commands to generate HTML pages.
+3. Manually copy/paste `latest.js` file in the resulting `recordrtc.org` directory
+4. Copy `recordrtc.org` directory and replace in `RecordRTC` github clone's `gh-pages` section
+5. Send a pull-request and done!
+
 ```
+# First step: install recordrtc.org template and javascript file
 npm install recordrtc.org
 
-# here is how to generate HTML files
+# Second step: generate HTML files from template & latest.js file
 cd .\node_modules\recordrtc.org
 
+# This command generates HTML pages from latest.js file
 node_modules\.bin\jsdoc node_modules\recordrtc\RecordRTC.js -d .\..\..\recordrtc.org node_modules\recordrtc\README.md -t template
@@ -499,14 +520,20 @@ ```
 ```
+# This command runs index.html file
+# You can use it to preview HTML pages (doc files)
 .\..\..\recordrtc.org\index.html
 ```
 
+## Send pull requests
+
 Now, you should fork this repository:
 
-* https://github.com/muaz-khan/RecordRTC
+* [https://github.com/muaz-khan/RecordRTC](https://github.com/muaz-khan/RecordRTC)
 
 And push/pull `recordrtc.org` directory to `gh-pages`.
 
+## How to modify `latest.js` file?
+
 RecordRTC is using comments format from jsdoc:
 
-* http://usejsdoc.org/
+* [http://usejsdoc.org/](http://usejsdoc.org/)
 
@@ -525,4 +552,22 @@ E.g.
 
+Example - [`stopRecording`](https://github.com/muaz-khan/RecordRTC/blob/gh-pages/latest.js#L206) method:
+
+```javascript
+/**
+ * This method stops recording. It takes single "callback" argument. It is suggested to get blob or URI in the callback to make sure all encoders finished their jobs.
+ * @param {function} callback - This callback function is invoked after completion of all encoding jobs.
+ * @method
+ * @memberof RecordRTC
+ * @instance
+ * @example
+ * recordRTC.stopRecording(function(videoURL) {
+ *     video.src = videoURL;
+ * });
+ * @todo Implement <code class="str">recordRTC.stopRecording().getDataURL(callback);</code>
+ */
+stopRecording: stopRecording,
+```
+
 ## 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).

No alert changes

Improved metrics

Total package byte prevSize

103025

increased by2.85%

Lines of code

2125

increased by0.33%

Number of lines in readme file

571

increased by8.56%

No dependency changes