webrtc-conductor - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

package.json

 {
   "name": "webrtc-conductor",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "A lightweight module to allow for efficient management, creation, reuse and destruction of WebRTC DataChannels.",
@@ -33,6 +33,3 @@ "main": "src/wrtc-res-man.js",
     "ws": "^0.8.0"
-  },
-  "optionalDependencies": {
-    "wrtc": "^0.0.59"
   }
 }

README.md

@@ -1,2 +0,2 @@
-# WebRTC Conductor [![Build Status](https://travis-ci.org/FelixMcFelix/webrtc-conductor.svg)](https://travis-ci.org/FelixMcFelix/webrtc-conductor)
+# WebRTC Conductor [![Build Status](https://travis-ci.org/FelixMcFelix/webrtc-conductor.svg)](https://travis-ci.org/FelixMcFelix/webrtc-conductor) [![Code Climate](https://codeclimate.com/github/FelixMcFelix/webrtc-conductor/badges/gpa.svg)](https://codeclimate.com/github/FelixMcFelix/webrtc-conductor)
 A lightweight ES6 module to allow for efficient and simple management, creation, reuse and destruction of WebRTC DataChannels - independent of the signalling channel used for negotiation.
@@ -29,1 +29,64 @@
 ```
+
+## Channels
+Although these are properly detailed in src/example_channels/structure_example.js, a rough description is as follows:
+
+```javascript
+function FooChannel(param){
+	// A reference to the bound manager.
+	// You may call:
+	//	_manager.response(msg, channel):			alert the manager that a response 
+	//												has been received, and delegate
+	//												parsing it to the given channel.
+	//
+	//	_manager.renameConnection(name1, name2):	inform the manager that it must
+	//												change a channel's name - typically
+	//												used for bootstrapping into a
+	//												P2P network.
+	this._manager = null;
+
+	// Internal ID used by the registry of the manager to help find
+	// registered channels by name.
+	this.internalID = "structure_example";
+
+	// Function called by manager when opening a new WebRTC Data Channel. This function
+	// is used to convert webrtc negotiation details into a form suitable for the
+	// channel, as well as sending this information along the channel.
+	this.send = function(id, type, data){
+		/*...*/
+	};
+
+	// Function called by the manager if the _manager.response(msg, channel)
+	// method is called. This function is used to parse and handle the data
+	// actually received, and interpret what class of message has been received.
+	this.onmessage = function(msg){
+		/*...*/
+	};
+
+	// An optional function called by the manager once the channel has been bound to it.
+	this.onbind = function(){
+		/*...*/
+	};
+
+	// Function called by the manager or application code if the channel must be closed.
+	// All cleanup and related logic should be handled here so that open connections
+	// are not left inaccessible by the program.
+	this.close = function(){
+		/* ... */
+	};
+}
+```
+
+If you are implementing your own channel, I strongly recommend referring to the specification document to be aware of expected return
+types, further conventions and so on.
+
+## Changelog
+
+***Note: Breaking changes will regularly occur before v1.0.0 due to instability of the library. Use at your own risk!***
+
+### 0.1.0
+* Addition of .renameConnection() method for channels to use in cases where the destination is not yet known.
+* Addition of .onconnection property, called when a channel is opened to the current user from another source.
+
+### 0.0.1
+* Initial Implementation

No alert changes

Improved metrics

Total package byte prevSize

37704

increased by22.55%

Dependency count

1

decreased by-50%

Number of package files

13

increased by18.18%

Number of lines in readme file

91

increased by213.79%

No dependency changes