From 4cb0116dda46c01cddcb4c96de352c40f0a69773 Mon Sep 17 00:00:00 2001
From: Braydon Fuller <braydon@bitpay.com>
Date: Thu, 18 Dec 2014 18:38:47 -0500
Subject: [PATCH] Added jsdoc2md to generate api reference documentation to
 markdown, and organized docs into 'api' and 'guide'

---
 docs/peer.md | 102 ---------------------------------------------------
 docs/pool.md |  30 ---------------
 2 files changed, 132 deletions(-)
 delete mode 100644 docs/peer.md
 delete mode 100644 docs/pool.md

diff --git a/docs/peer.md b/docs/peer.md
deleted file mode 100644
index b0f9201..0000000
--- a/docs/peer.md
+++ /dev/null
@@ -1,102 +0,0 @@
-# > `bitcore.transport.Peer`
-
-## Description
-
-Represents a node from the p2p bitcoin network. The Peer class supports connecting directly to other nodes or through a socks5 proxy like Tor.
-
-## Creating a peer
-
-The code to create a new peer looks like this:
-
-```javascript
-var bitcore = require('bitcore');
-var Peer = bitcore.transport.Peer;
-
-// default port
-var livenetPeer = new Peer('5.9.85.34');
-var testnetPeer = new Peer('5.9.85.34', bitcore.testnet);
-
-// custom port
-var livenetPeer = new Peer('5.9.85.34', 8334);
-var testnetPeer = new Peer('5.9.85.34', 18334, bitcore.testnet);
-
-// use sock5 proxy (Tor)
-var peer = new Peer('5.9.85.34').setProxy('localhost', 9050);
-```
-
-## States
-
-A peer instance is always in one of the following states:
-
-* `disconnected`: No connection with the remote node.
-* `connecting`: While establishing the connection.
-* `connected`: Exchanging version packages.
-* `ready`: Connection ready for sending and receiving messages.
-
-You can subscribe to the change of those states as follows:
-
-```javascript
-var bitcore = require('bitcore');
-var Peer = bitcore.transport.Peer;
-
-var peer = new Peer('5.9.85.34');
-
-peer.on('ready', function() {
-  // peer info
-  console.log(peer.version, peer.subversion, peer.bestHeight);
-});
-
-peer.on('disconnect', function() {
-  console.log('connection closed');
-});
-
-peer.connect();
-```
-
-## Handle messages
-
-Once connected, a peer instance can send and receive messages. Every time a message arrives it's emitted as a new event. Let's see an example of this:
-
-```javascript
-var bitcore = require('bitcore');
-var peer = new bitcore.transport.Peer('5.9.85.34');
-
-// handle events
-peer.on('inv', function(message) {
-  // message.inventory[]
-});
-
-peer.on('tx', function(message) {
-  // message.transaction
-});
-
-peer.on('addr', function(message) {
-  // message.addresses[]
-});
-
-peer.connect();
-```
-
-## Sending messages
-
-In order to send messages the Peer class offers the `sendMessage(message)` method, which receives an instance of a message. All supported messages can be found on the `bitcore.transport.Messages` module. For more information about messages refer to the [protocol specification](https://en.bitcoin.it/wiki/Protocol_specification).
-
-An example for requesting other connected nodes to a peers looks like this:
-
-```javascript
-var bitcore = require('bitcore');
-var peer = new bitcore.transport.Peer('5.9.85.34');
-
-peer.on('ready', function() {
-  var message = new bitcore.transport.Messages.GetAddresses();
-  peer.sendMessage(message);
-});
-
-peer.on('addr', function(message) {
-  message.addresses.forEach(function(address) {
-    // do something
-  });
-});
-
-peer.connect();
-```
diff --git a/docs/pool.md b/docs/pool.md
deleted file mode 100644
index 1622142..0000000
--- a/docs/pool.md
+++ /dev/null
@@ -1,30 +0,0 @@
-# > `bitcore.transport.Pool`
-
-## Pool
-
-A pool maintains a connection of [Peers](Peer.md). A pool will discover peers via DNS seeds, as well as when peer addresses are announced through the network.
-
-The quickest way to get connected is to run the following:
-
-```javascript
-
-var bitcore = require('bitcore');
-var Pool = bitcore.transport.Pool;
-var Networks = bitcore.Networks;
-
-var pool = new Pool(Networks.livenet);
-
-// connect to the network
-pool.connect();
-
-// attach peer events
-pool.on('peerinv', function(peer, message) {
-  // a new peer message has arrived
-});
-
-// will disconnect all peers
-pool.disconnect()
-
-```
-
-For more information about Peer events, please read the [Peer](Peer.md) documentation. Peer events are relayed to the pool, a peer event `inv` in the pool would be `peerinv`. When a peer is disconnected the pool will try to connect to the list of known addresses to maintain connection.