fcoin/docs/README.md
2017-10-09 21:18:31 +04:00

52 lines
1.7 KiB
Markdown

Welcome to the bcoin docs!
## Getting Started
- [Getting Started][getting-started]
- [Configuration][configuration]
- [Wallet System][wallet-system]
- [Design][design]
- [Guides][guides]
## Running
- [Bcoin CLI][cli]
- [Running in the Browser][browser]
- [REST and RPC API][rest-rpc]
## Code Examples
- [Simple Fullnode][example-simple-fullnode]
- [Connect to Peer][example-connect-peer]
- [Connecting to the P2P Network][example-p2p]
- [Creating a Blockchain and Mempool][example-blockchain]
- [Wallet with Dummy TX][example-wallet-dummy]
- [Fullnode Object][example-fullnode-wallet]
- [SPV Sync][example-spv]
- [Plugin Example][example-peers-plugin]
- [Client API Usage][example-client-api]
- [Miner with WorkerPool][example-miner-configs]
- [Create and Sign TX][example-tx-create-sign]
- [Get Transaction from Chain][example-tx-from-chain]
[getting-started]: Beginner's-Guide.md
[configuration]: Configuration.md
[design]: Design.md
[wallet-system]: Wallet-System.md
[guides]: http://bcoin.io/guides.html
[cli]: CLI.md
[browser]: Running-in-the-browser.md
[rest-rpc]: http://bcoin.io/api-docs/index.html#introduction
[example-p2p]: Examples/connect-to-the-p2p-network.js
[example-blockchain]: Examples/create-a-blockchain-and-mempool.js
[example-fullnode-wallet]: Examples/fullnode-and-wallet.js
[example-spv]: Examples/spv-sync-wallet.js
[example-wallet-dummy]: Examples/wallet.js
[example-peers-plugin]: Examples/peers-plugin.js
[example-client-api]: Examples/client-api.js
[example-miner-configs]: Examples/miner-configs.js
[example-connect-peer]: Examples/connect-to-peer.js
[example-simple-fullnode]: Examples/fullnode.js
[example-tx-create-sign]: Examples/create-sign-tx.js
[example-tx-from-chain]: Examples/get-tx-from-chain.js