RanchiMall/flocore-p2p
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

improved peer jsdoc, fixed docs for messages, and switched to use svg for readme icon

Browse Source
This commit is contained in:
Braydon Fuller 2015-03-16 15:44:50 -04:00
parent 8f2d0089df
commit 664ceb2d30
3 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -1,4 +1,4 @@
<img src="http://bitcore.io/css/images/module-p2p.png" alt="bitcore payment protocol" height="35" width="102">
<img src="http://bitcore.io/css/images/bitcore-p2p.svg" alt="bitcore payment protocol" height="35" width="102">
Bitcore P2P
=======

2
docs/messages.md
View File

@ -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();

7
lib/peer.js
View File

@ -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