need usage documentation

freedomjs / freedom-port-control

Opens ports through a NAT with NAT-PMP, PCP, and UPnP

11 stars 3 forks source link

Open willscott opened 8 years ago

willscott commented 8 years ago

Currently, the documentation doesn't provide a clear way for how to use this code. In node, it probably looks something like:

var freedom = require('freedom-for-node');
freedom('node_modules/freedom-port-control/dist/port-control.json').then(function(portControl) {
  ...
});