diff --git a/README.md b/README.md index fe3cb48..616e753 100644 --- a/README.md +++ b/README.md @@ -129,11 +129,11 @@ var verackmsg = structs.message.encode("verack"); console.log(structs.message.decode(verackmsg).command); // verack ``` -### Network +### Networking ```js var messages = require("bitmessage").messages; -var TcpTransport = require("bitmessage/net/tcp"); +var TcpTransport = require("bitmessage/lib/net/tcp"); var tcp = new TcpTransport({ dnsSeeds: [["bootstrap8444.bitmessage.org", 8444]], diff --git a/lib/address.js b/lib/address.js index 4a4a5f5..67be371 100644 --- a/lib/address.js +++ b/lib/address.js @@ -3,7 +3,7 @@ * **NOTE**: `Address` is exported as a module. * @example * var Address = require("bitmessage").Address; - * // Or: var Address = require("bitmessage/address"); + * // Or: var Address = require("bitmessage/lib/address"); * * // Generate a new random Bitmessage identity. * var addr1 = Address.fromRandom(); diff --git a/lib/net/base.js b/lib/net/base.js index c21310c..1786b77 100644 --- a/lib/net/base.js +++ b/lib/net/base.js @@ -3,8 +3,8 @@ * implementing new transports. End-users should import some transport * instead in order to connect/accept connections to/from other nodes. * **NOTE**: `BaseTransport` is exported as a module. - * @example var BaseTransport = require("bitmessage/net/base"); - * @module bitmessage/net/base + * @example var BaseTransport = require("bitmessage/lib/net/base"); + * @module bitmessage/lib/net/base */ // TODO(Kagami): Write some sort of tutorial. diff --git a/lib/net/tcp.js b/lib/net/tcp.js index 0a50cc6..5f4d62d 100644 --- a/lib/net/tcp.js +++ b/lib/net/tcp.js @@ -2,10 +2,10 @@ * TCP transport compatible with PyBitmessage. Available only for Node * platform. * **NOTE**: `TcpTransport` is exported as a module. - * @module bitmessage/net/tcp + * @module bitmessage/lib/net/tcp * @example * var messages = require("bitmessage").messages; - * var TcpTransport = require("bitmessage/net/tcp"); + * var TcpTransport = require("bitmessage/lib/net/tcp"); * * var tcp = new TcpTransport({ * dnsSeeds: [["bootstrap8444.bitmessage.org", 8444]], @@ -48,8 +48,8 @@ var getmsg = BaseTransport._getmsg; var unmap = BaseTransport._unmap; /** - * TCP transport class. Implements - * [base transport interface]{@link module:bitmessage/net/base.BaseTransport}. + * TCP transport class. Implements [base transport interface]{@link + * module:bitmessage/lib/net/base.BaseTransport}. * @param {Object=} opts - Transport options * @param {Array} opts.seeds - Bootstrap nodes (none by default) * @param {Array} opts.dnsSeeds - Bootstrap DNS nodes (none by default) diff --git a/lib/net/ws.js b/lib/net/ws.js index d4f0f05..bb30ae6 100644 --- a/lib/net/ws.js +++ b/lib/net/ws.js @@ -3,8 +3,8 @@ * so we use separate WebSocket server to proxy messages into TCP data * packets. Available for both Node.js and Browser platforms. * **NOTE**: `WsTransport` is exported as a module. - * @example var WsTransport = require("bitmessage/net/ws"); - * @module bitmessage/net/ws + * @example var WsTransport = require("bitmessage/lib/net/ws"); + * @module bitmessage/lib/net/ws */ "use strict"; @@ -23,8 +23,8 @@ var getmsg = BaseTransport._getmsg; var unmap = BaseTransport._unmap; /** - * WebSocket transport class. Implements - * [base transport interface]{@link module:bitmessage/net/base.BaseTransport}. + * WebSocket transport class. Implements [base transport + * interface]{@link module:bitmessage/lib/net/base.BaseTransport}. * @param {Object=} opts - Transport options * @param {Array} opts.seeds - Bootstrap nodes (none by default) * @param {Object} opts.services -