diff --git a/README.md b/README.md index 2dfc7be..cd77df1 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -bitcore payment protocol +bitcore payment protocol Bitcore P2P ======= diff --git a/docs/messages.md b/docs/messages.md index ad9e667..9d6bcfe 100644 --- a/docs/messages.md +++ b/docs/messages.md @@ -6,7 +6,7 @@ description: A superclass for the messages of the bitcoin network The bitcoin protocol specifies a set of [messages](https://en.bitcoin.it/wiki/Protocol_specification) that can be sent from peer to peer. `bitcore-p2p` provides support for some of these messages. -To create a messages, you can use any of the message constructors, here is a simple example: +To create a message, you can use any of the message constructors, here is a simple example: ```javascript var messages = new Messages(); diff --git a/lib/peer.js b/lib/peer.js index 1b789f1..5efb9ed 100644 --- a/lib/peer.js +++ b/lib/peer.js @@ -11,8 +11,11 @@ var $ = bitcore.util.preconditions; var util = require('util'); /** - * A constructor to create Peer instances to send and recieve messages - * using the standard Bitcoin protocol. + * The Peer constructor will create an instance of Peer to send and recieve messages + * using the standard Bitcoin protocol. A Peer instance represents one connection + * on the Bitcoin network. To create a new peer connection provide the host and port + * options and then invoke the connect method. Additionally, a newly connected socket + * can be provided instead of host and port. * * @example * ```javascript