Merge pull request #845 from yemel/docs/description
Add title and description to doc files
This commit is contained in:
commit
565aefd196
|
@ -1,3 +1,6 @@
|
|||
title: Bitcore Examples
|
||||
description: Sample code for the most common task in any bitcoin application.
|
||||
---
|
||||
# Examples
|
||||
|
||||
## Create a Private Key
|
||||
|
|
|
@ -1,3 +1,6 @@
|
|||
title: Address
|
||||
description: A simple interface to generate and validate a bitcoin address.
|
||||
---
|
||||
# Address
|
||||
|
||||
## Description
|
||||
|
|
|
@ -1,3 +1,6 @@
|
|||
title: Block
|
||||
description: A simple interface to parse and validate a bitcoin blocks.
|
||||
---
|
||||
# Block
|
||||
|
||||
## Description
|
||||
|
|
|
@ -1,3 +1,6 @@
|
|||
title: Crypto
|
||||
description: Primitives and tools to deal with bitcoin cryptography.
|
||||
---
|
||||
# Crypto
|
||||
|
||||
## Description
|
||||
|
|
|
@ -1,3 +1,6 @@
|
|||
title: ECIES
|
||||
description: Uses ECIES symmetric key negotiation from public keys to encrypt arbitrarily long data streams.
|
||||
---
|
||||
# ECIES
|
||||
|
||||
## Description
|
||||
|
|
|
@ -1,3 +1,6 @@
|
|||
title: Encoding
|
||||
description: Utilities for encoding information in bitcoin standard formats.
|
||||
---
|
||||
# Encoding
|
||||
|
||||
## Description
|
||||
|
|
|
@ -1,3 +1,6 @@
|
|||
title: HDKeys
|
||||
description: Lets you create and derive extended public and private keys according to the BIP32 standard for Hierarchical Deterministic (HD) keys.
|
||||
---
|
||||
# HDKeys
|
||||
|
||||
## Hierarichically Derived Keys
|
||||
|
|
|
@ -1,3 +1,6 @@
|
|||
title: JSON-RPC
|
||||
description: A simple interface to connect and make RPC calls to bitcoind.
|
||||
---
|
||||
# JSON-RPC
|
||||
|
||||
## Description
|
||||
|
|
|
@ -1,3 +1,6 @@
|
|||
title: Networks
|
||||
description: A simple interface to handle livenet and testnet bitcoin networks.
|
||||
---
|
||||
# Networks
|
||||
|
||||
## Description
|
||||
|
|
|
@ -1,3 +1,6 @@
|
|||
title: Payment Protocol
|
||||
description: A powerful interface for serialize, deserialize, sign and verify payment protocol messsages.
|
||||
---
|
||||
# Payment Protocol
|
||||
|
||||
## Description
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -1,3 +1,6 @@
|
|||
title: Pool
|
||||
description: A simple interface to create and maintain a set of connections to bitcoin nodes.
|
||||
---
|
||||
# Pool
|
||||
|
||||
## Pool
|
||||
|
|
|
@ -1,3 +1,6 @@
|
|||
title: Private Key
|
||||
description: A simple interface to generate, import and handle private keys.
|
||||
---
|
||||
# Private Key
|
||||
|
||||
## Description
|
||||
|
|
|
@ -1,3 +1,6 @@
|
|||
title: Public Key
|
||||
description: A simple interface for handling private keys.
|
||||
---
|
||||
# Public Key
|
||||
|
||||
## Description
|
||||
|
|
|
@ -1,3 +1,6 @@
|
|||
title: Script
|
||||
description: A powerful interface to create, parse and validate bitcoin scripts.
|
||||
---
|
||||
# Script
|
||||
|
||||
## Description
|
||||
|
|
|
@ -1,3 +1,6 @@
|
|||
title: Transaction
|
||||
description: A robust interface to create, parse and validate bitcoin transactions.
|
||||
---
|
||||
# Transaction
|
||||
|
||||
## Description
|
||||
|
|
|
@ -1,3 +1,6 @@
|
|||
title: Bitcoin Units
|
||||
description: Utility to easily convert between bitcoin units.
|
||||
---
|
||||
# Unit
|
||||
|
||||
## Description
|
||||
|
|
|
@ -1,3 +1,6 @@
|
|||
title: Bitcoin URIs
|
||||
description: Utility to parse and create standard bitcoin URIs.
|
||||
---
|
||||
# URI
|
||||
|
||||
## Description
|
||||
|
|
Loading…
Reference in New Issue