Merge pull request #982 from braydonf/docs/prepare-for-submodule

Moved documentation from docs/guide to docs directory

docs/README.md

@@ -1,4 +0,0 @@
-Bitcore API Reference
-=======
-
-This site contains the reference docs for the bitcore library.

docs/guide/address.md → docs/address.md

@@ -1,3 +1,4 @@
+---
 title: Address
 description: A simple interface to generate and validate a bitcoin address.
 ---

docs/api/index.md

@@ -1,56 +0,0 @@
-title: Bitcore Examples
-description: Sample code for the most common task in any bitcoin application.
----
-# Examples
-
-## Create a Private Key
-
-```javascript
-var privKey = new bitcore.PrivateKey();
-```
-
-## Create an Address
-
-```javascript
-var privKey = new bitcore.PrivateKey();
-var address = privKey.toAddress();
-```
-
-## Create a Multisig Address
-
-```javascript
-// Build a 2-of-3 address from public keys
-var P2SHAddress = new bitcore.Address([publicKey1, publicKey2, publicKey3], 2);
-```
-
-## Request a Payment
-
-```javascript
-var paymentInfo = {
-  address: '1DNtTk4PUCGAdiNETAzQFWZiy2fCHtGnPx',
-  amount: 120000 //satoshis
-};
-var uri = new bitcore.URI(paymentInfo).toString();
-```
-
-## Create a Transaction
-
-```javascript
-var transaction = new Transaction()
-    .from(utxos)          // Feed information about what unspend outputs one can use
-    .to(address, amount)  // Add an output with the given amount of satoshis
-    .change(address)      // Sets up a change address where the rest of the funds will go
-    .sign(privkeySet)     // Signs all the inputs it can
-```
-
-## Connect to the Network
-
-```javascript
-var peer = new Peer('5.9.85.34');
-
-peer.on('inv', function(message) {
-  // new invetory
-});
-
-peer.connect();
-```

docs/guide/block.md → docs/block.md

@@ -1,3 +1,4 @@
+---
 title: Block
 description: A simple interface to parse and validate a bitcoin blocks.
 ---

docs/guide/browser.md → docs/browser.md

@@ -1,3 +1,4 @@
+---
 title: Browser Builds
 description: Guide to writing modules and optimizing browser bundles.
 ---

docs/guide/crypto.md → docs/crypto.md

@@ -1,3 +1,4 @@
+---
 title: Crypto
 description: Primitives and tools to deal with bitcoin cryptography.
 ---

docs/guide/encoding.md → docs/encoding.md

@@ -1,3 +1,4 @@
+---
 title: Encoding
 description: Utilities for encoding information in bitcoin standard formats.
 ---

docs/guide/hierarchical.md → docs/hierarchical.md

@@ -1,3 +1,4 @@
+---
 title: HDKeys
 description: Lets you create and derive extended public and private keys according to the BIP32 standard for Hierarchical Deterministic (HD) keys.
 ---

docs/guide/index.md → docs/index.md

@@ -36,7 +36,7 @@ To get started, just `npm install bitcore` or `bower install bitcore`.
 Some functionality is implemented as a module that can be installed seperately:
 
 * [Payment Protocol Support](https://github.com/bitpay/bitcore-payment-protocol)
-* [Peer to Peer Networking](https://github.com/bitpay/bitcore-payment-protocol)
+* [Peer to Peer Networking](https://github.com/bitpay/bitcore-p2p)
 * [Bitcoin Core JSON-RPC](https://github.com/bitpay/bitcoind-rpc)
 * [Payment Channels](https://github.com/bitpay/bitcore-channel)
 * [Mnemonics](https://github.com/bitpay/bitcore-mnemonic)

docs/guide/networks.md → docs/networks.md

@@ -1,3 +1,4 @@
+---
 title: Networks
 description: A simple interface to handle livenet and testnet bitcoin networks.
 ---

docs/guide/privatekey.md → docs/privatekey.md

@@ -1,3 +1,4 @@
+---
 title: Private Key
 description: A simple interface to generate, import and handle private keys.
 ---

docs/guide/publickey.md → docs/publickey.md

@@ -1,3 +1,4 @@
+---
 title: Public Key
 description: A simple interface for handling private keys.
 ---

docs/guide/script.md → docs/script.md

@@ -1,3 +1,4 @@
+---
 title: Script
 description: A powerful interface to create, parse and validate bitcoin scripts.
 ---

docs/guide/transaction.md → docs/transaction.md

@@ -1,3 +1,4 @@
+---
 title: Transaction
 description: A robust interface to create, parse and validate bitcoin transactions.
 ---

docs/guide/unit.md → docs/unit.md

@@ -1,3 +1,4 @@
+---
 title: Bitcoin Units
 description: Utility to easily convert between bitcoin units.
 ---

docs/guide/unspentoutput.md → docs/unspentoutput.md

@@ -1,3 +1,4 @@
+---
 title: UnspentOutput
 description: A stateless model to represent an unspent output and associated information.
 ---

docs/guide/uri.md → docs/uri.md

@@ -1,3 +1,4 @@
+---
 title: Bitcoin URIs
 description: Utility to parse and create standard bitcoin URIs.
 ---