From a1ceb0e8dcfd748461a7fa45c69bc5b340378ab5 Mon Sep 17 00:00:00 2001 From: Yemel Jardi Date: Tue, 23 Dec 2014 12:28:31 -0300 Subject: [PATCH] Add title and description to doc files --- docs/api/index.md | 3 +++ docs/guide/address.md | 3 +++ docs/guide/block.md | 3 +++ docs/guide/crypto.md | 3 +++ docs/guide/ecies.md | 3 +++ docs/guide/encoding.md | 3 +++ docs/guide/hierarchical.md | 3 +++ docs/guide/jsonrpc.md | 3 +++ docs/guide/networks.md | 3 +++ docs/guide/paymentprotocol.md | 3 +++ docs/guide/peer.md | 3 +++ docs/guide/pool.md | 3 +++ docs/guide/privatekey.md | 3 +++ docs/guide/publickey.md | 3 +++ docs/guide/script.md | 3 +++ docs/guide/transaction.md | 3 +++ docs/guide/unit.md | 3 +++ docs/guide/uri.md | 3 +++ 18 files changed, 54 insertions(+) diff --git a/docs/api/index.md b/docs/api/index.md index e5ea8b9..122b3c5 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -1,3 +1,6 @@ +title: Bitcore Examples +description: Sample code for the most common task in any bitcoin application. +--- # Examples ## Create a Private Key diff --git a/docs/guide/address.md b/docs/guide/address.md index 94225af..8663b4c 100644 --- a/docs/guide/address.md +++ b/docs/guide/address.md @@ -1,3 +1,6 @@ +title: Address +description: A simple interface to generate and validate a bitcoin address. +--- # Address ## Description diff --git a/docs/guide/block.md b/docs/guide/block.md index 2055202..6d88692 100644 --- a/docs/guide/block.md +++ b/docs/guide/block.md @@ -1,3 +1,6 @@ +title: Block +description: A simple interface to parse and validate a bitcoin blocks. +--- # Block ## Description diff --git a/docs/guide/crypto.md b/docs/guide/crypto.md index ac09d32..e5499c8 100644 --- a/docs/guide/crypto.md +++ b/docs/guide/crypto.md @@ -1,3 +1,6 @@ +title: Crypto +description: Primitives and tools to deal with bitcoin cryptography. +--- # Crypto ## Description diff --git a/docs/guide/ecies.md b/docs/guide/ecies.md index da60a40..590fb89 100644 --- a/docs/guide/ecies.md +++ b/docs/guide/ecies.md @@ -1,3 +1,6 @@ +title: ECIES +description: Perform bulk encryption on data using a symmetric cipher and a random key. +--- # ECIES ## Description diff --git a/docs/guide/encoding.md b/docs/guide/encoding.md index 3c21de1..a2d0d00 100644 --- a/docs/guide/encoding.md +++ b/docs/guide/encoding.md @@ -1,3 +1,6 @@ +title: Encoding +description: Utilities for encoding information in bitcoin standard formats. +--- # Encoding ## Description diff --git a/docs/guide/hierarchical.md b/docs/guide/hierarchical.md index 2806dfb..8cc453d 100644 --- a/docs/guide/hierarchical.md +++ b/docs/guide/hierarchical.md @@ -1,3 +1,6 @@ +title: HD Keys +description: Hierarichically derived keys support, let's you create and derive extended public and private keys. +--- # HDKeys ## Hierarichically Derived Keys diff --git a/docs/guide/jsonrpc.md b/docs/guide/jsonrpc.md index d5f11fb..454cb87 100644 --- a/docs/guide/jsonrpc.md +++ b/docs/guide/jsonrpc.md @@ -1,3 +1,6 @@ +title: JSON-RPC +description: A simple interface to connect and make RPC calls to bitcoind. +--- # JSON-RPC ## Description diff --git a/docs/guide/networks.md b/docs/guide/networks.md index 8598af2..b35e4c9 100644 --- a/docs/guide/networks.md +++ b/docs/guide/networks.md @@ -1,3 +1,6 @@ +title: Networks +description: A simple interface to handle livenet and testnet bitcoin networks. +--- # Networks ## Description diff --git a/docs/guide/paymentprotocol.md b/docs/guide/paymentprotocol.md index 1b16acf..c9c6545 100644 --- a/docs/guide/paymentprotocol.md +++ b/docs/guide/paymentprotocol.md @@ -1,3 +1,6 @@ +title: Payment Protocol +description: A powerful interface for serialize, deserialize, sign and verify payment protocol messsages. +--- # Payment Protocol ## Description diff --git a/docs/guide/peer.md b/docs/guide/peer.md index 5bb0278..53ca127 100644 --- a/docs/guide/peer.md +++ b/docs/guide/peer.md @@ -1,3 +1,6 @@ +title: Peer +description: The Peer class privides a simple interface for connecting to a node in the bitcoin network. +--- # Peer ## Description diff --git a/docs/guide/pool.md b/docs/guide/pool.md index 49ecd67..34f1f9f 100644 --- a/docs/guide/pool.md +++ b/docs/guide/pool.md @@ -1,3 +1,6 @@ +title: Pool +description: A simple interface to create and maintain a set of connections to bitcoin nodes. +--- # Pool ## Pool diff --git a/docs/guide/privatekey.md b/docs/guide/privatekey.md index d2ec5aa..d8cdfe0 100644 --- a/docs/guide/privatekey.md +++ b/docs/guide/privatekey.md @@ -1,3 +1,6 @@ +title: Private Key +description: A simple interface to generate, import and handle private keys. +--- # Private Key ## Description diff --git a/docs/guide/publickey.md b/docs/guide/publickey.md index b93063c..983120f 100644 --- a/docs/guide/publickey.md +++ b/docs/guide/publickey.md @@ -1,3 +1,6 @@ +title: Public Key +description: A simple interface for handling private keys. +--- # Public Key ## Description diff --git a/docs/guide/script.md b/docs/guide/script.md index c691928..b88fb3d 100644 --- a/docs/guide/script.md +++ b/docs/guide/script.md @@ -1,3 +1,6 @@ +title: Script +description: A powerful interface to create, parse and validate bitcoin scripts. +--- # Script ## Description diff --git a/docs/guide/transaction.md b/docs/guide/transaction.md index 82b6aee..1fb97ef 100644 --- a/docs/guide/transaction.md +++ b/docs/guide/transaction.md @@ -1,3 +1,6 @@ +title: Transaction +description: A robust interface to create, parse and validate bitcoin transactions. +--- # Transaction ## Description diff --git a/docs/guide/unit.md b/docs/guide/unit.md index 3a3344f..825ad20 100644 --- a/docs/guide/unit.md +++ b/docs/guide/unit.md @@ -1,3 +1,6 @@ +title: Bitcoin Units +description: Utility to easily convert between bitcoin units. +--- # Unit ## Description diff --git a/docs/guide/uri.md b/docs/guide/uri.md index 0f431a1..a1b51a3 100644 --- a/docs/guide/uri.md +++ b/docs/guide/uri.md @@ -1,3 +1,6 @@ +title: Bitcoin URIs +description: Utility to parse and create standard bitcoin URIs. +--- # URI ## Description