Update README to start a full node.
This commit is contained in:
Braydon Fuller
parent
2d7d7c4fcc
commit
6361201862
36
.jsdoc.conf
36
.jsdoc.conf
|
|
@ -1,36 +0,0 @@
|
|||
{
|
||||
"tags": {
|
||||
"allowUnknownTags": true
|
||||
},
|
||||
"source": {
|
||||
"include": ["docs/README.md"],
|
||||
"exclude": [],
|
||||
"includePattern": "lib/.+\\.js(doc)?$",
|
||||
"excludePattern": "(^|\\/|\\\\)_"
|
||||
},
|
||||
"plugins": ["plugins/markdown"],
|
||||
"templates": {
|
||||
"cleverLinks": false,
|
||||
"monospaceLinks": false
|
||||
},
|
||||
"opts": {
|
||||
"template": "node_modules/ink-docstrap/template",
|
||||
"encoding": "utf8",
|
||||
"destination": "./apiref/",
|
||||
"recurse": true,
|
||||
"query": "value",
|
||||
"private": true,
|
||||
"lenient": true
|
||||
},
|
||||
"templates": {
|
||||
"systemName": "bitcore",
|
||||
"copyright": "© 2013-2015, BitPay Inc.",
|
||||
"navType": "vertical",
|
||||
"theme": "journal",
|
||||
"linenums": true,
|
||||
"collapseSymbols": false,
|
||||
"inverseNav": false,
|
||||
"outputSourceFiles": true
|
||||
}
|
||||
|
||||
}
|
||||
75
README.md
75
README.md
|
|
@ -5,30 +5,59 @@ Bitcore
|
|||
[](https://travis-ci.org/bitpay/bitcore)
|
||||
[](https://coveralls.io/r/bitpay/bitcore)
|
||||
|
||||
Infrastructure to build Bitcoin and blockchain-based applications for the next generation of financial technology.
|
||||
|
||||
A pure and powerful JavaScript Bitcoin library.
|
||||
## Getting Started
|
||||
|
||||
## Principles
|
||||
Install with Node.js
|
||||
|
||||
Bitcoin is a powerful new peer-to-peer platform for the next generation of financial technology. The decentralized nature of the Bitcoin network allows for highly resilient bitcoin infrastructure, and the developer community needs reliable, open-source tools to implement bitcoin apps and services.
|
||||
|
||||
## Get Started
|
||||
|
||||
```
|
||||
npm install bitcore
|
||||
```bash
|
||||
npm install -g bitcore
|
||||
```
|
||||
|
||||
Using it in Node.js:
|
||||
Install for web browsers:
|
||||
|
||||
```javascript
|
||||
```bash
|
||||
bower install bitcore
|
||||
```
|
||||
|
||||
Spin up a full node and join the network:
|
||||
|
||||
```bash
|
||||
npm install -g bitcore
|
||||
bitcore init mynode
|
||||
cd mynode
|
||||
bitcore start
|
||||
```
|
||||
|
||||
Create a transaction:
|
||||
```js
|
||||
var bitcore = require('bitcore');
|
||||
|
||||
assert(bitcore.Address.isValid('126vMmY1fyznpZiFTTnty3cm1Rw8wuheev'));
|
||||
var simpleTx = new bitcore.Transaction();
|
||||
var simpleTx.from(unspent).to(address, amount);
|
||||
simpleTx.sign(privateKey);
|
||||
var transaction = new bitcore.Transaction();
|
||||
var transaction.from(unspent).to(address, amount);
|
||||
transaction.sign(privateKey);
|
||||
```
|
||||
|
||||
## Applications
|
||||
|
||||
- [Node](https://github.com/bitpay/bitcore-node) - A full node with extended capabilities using Bitcoin Core
|
||||
- [Insight API](https://github.com/bitpay/insight-api) - A blockchain explorer HTTP API
|
||||
- [Insight UI](https://github.com/bitpay/insight) - A blockchain explorer web user interface
|
||||
- [Wallet Service](https://github.com/bitpay/bitcore-wallet-service) - A multisig HD service for wallets
|
||||
- [Wallet Client](https://github.com/bitpay/bitcore-wallet-client) - A client for the wallet service
|
||||
- [CLI Wallet](https://github.com/bitpay/bitcore-wallet) - A command-line based wallet client
|
||||
- [Angular Wallet Client](https://github.com/bitpay/angular-bitcore-wallet-client) - An Angular based wallet client
|
||||
- [Copay](https://github.com/bitpay/copay) - An easy-to-use, multiplatform, multisignature, secure bitcoin wallet.
|
||||
|
||||
## Extended Features
|
||||
|
||||
- [Payment Protocol](https://github.com/bitpay/bitcore-payment-protocol) - A protocol for merchant's and customer's wallet
|
||||
- [P2P](https://github.com/bitpay/bitcore-p2p) - Peer-to-Peer networking
|
||||
- [Mnemonic](https://github.com/bitpay/bitcore-mnemonic) - Implements Mnemonic code for generating deterministic keys.
|
||||
- [Channel](https://github.com/bitpay/bitcore-channel) - Micro-payment channels
|
||||
- [Message](https://github.com/bitpay/bitcore-message) - Bitcoin message verification and signing
|
||||
- [ECIES](https://github.com/bitpay/bitcore-ecies) - Elliptic Curve Integrated Encryption Scheme (ECIES)
|
||||
|
||||
## Documentation
|
||||
|
||||
The complete docs are hosted here: [bitcore documentation](http://bitcore.io/guide/). There's also a [bitcore API reference](http://bitcore.io/api/) available generated from the JSDocs of the project, where you'll find low-level details on each bitcore utility.
|
||||
|
|
@ -50,20 +79,6 @@ To get community assistance and ask for help with implementation questions, plea
|
|||
* [Create a 2-of-3 multisig P2SH address](https://github.com/bitpay/bitcore/blob/master/docs/examples.md#create-a-2-of-3-multisig-p2sh-address)
|
||||
* [Spend from a 2-of-2 multisig P2SH address](https://github.com/bitpay/bitcore/blob/master/docs/examples.md#spend-from-a-2-of-2-multisig-p2sh-address)
|
||||
|
||||
|
||||
## Modules
|
||||
This module provides bitcoin's core features. Other features and protocol extensions are built into separate modules. Here is a list of official bitcore modules:
|
||||
|
||||
Module | Version | Building | Coverage
|
||||
-------|---------|----------|---------
|
||||
<a href="http://github.com/bitpay/bitcore-payment-protocol"><img src="http://bitcore.io/css/images/bitcore-payment-protocol.svg" alt="bitcore-payment-protocol" height="28"></a> | [](https://www.npmjs.org/package/bitcore-payment-protocol) | [](https://travis-ci.org/bitpay/bitcore-payment-protocol) | [](https://coveralls.io/r/bitpay/bitcore-payment-protocol)
|
||||
<a href="http://github.com/bitpay/bitcore-p2p"><img src="http://bitcore.io/css/images/bitcore-p2p.svg" alt="bitcore-p2p" height="28"></a> | [](https://www.npmjs.org/package/bitcore-p2p) | [](https://travis-ci.org/bitpay/bitcore-p2p) | [](https://coveralls.io/r/bitpay/bitcore-p2p?branch=master)
|
||||
<a href="http://github.com/bitpay/bitcore-mnemonic"><img src="http://bitcore.io/css/images/bitcore-mnemonic.svg" alt="bitcore-mnemonic" height="28"></a> | [](https://www.npmjs.org/package/bitcore-mnemonic) | [](https://travis-ci.org/bitpay/bitcore-mnemonic) | [](https://coveralls.io/r/bitpay/bitcore-mnemonic)
|
||||
<a href="http://github.com/bitpay/bitcore-ecies"><img src="http://bitcore.io/css/images/bitcore-ecies.svg" alt="bitcore-ecies" height="25"></a> | [](https://www.npmjs.org/package/bitcore-ecies) | [](https://travis-ci.org/bitpay/bitcore-ecies) | [](https://coveralls.io/r/bitpay/bitcore-ecies)
|
||||
<a href="http://github.com/bitpay/bitcore-channel"><img src="http://bitcore.io/css/images/bitcore-channel.svg" alt="bitcore-channel" height="28"></a> | [](https://www.npmjs.org/package/bitcore-channel) | [](https://travis-ci.org/bitpay/bitcore-channel) | [](https://coveralls.io/r/bitpay/bitcore-channel)
|
||||
<a href="http://github.com/bitpay/bitcore-explorers"><img src="http://bitcore.io/css/images/bitcore-explorers.svg" alt="bitcore-explorers" height="28"></a> | [](https://www.npmjs.org/package/bitcore-explorers) | [](https://travis-ci.org/bitpay/bitcore-explorers) | [](https://coveralls.io/r/bitpay/bitcore-explorers)
|
||||
<a href="http://github.com/bitpay/bitcore-message"><img src="http://bitcore.io/css/images/bitcore-message.svg" alt="bitcore-message" height="28"></a> | [](https://www.npmjs.org/package/bitcore-message) | [](https://travis-ci.org/bitpay/bitcore-message) | [](https://coveralls.io/r/bitpay/bitcore-message)
|
||||
|
||||
## Security
|
||||
|
||||
We're using Bitcore in production, as are [many others](http://bitcore.io#projects), but please use common sense when doing anything related to finances! We take no responsibility for your implementation decisions.
|
||||
|
|
@ -72,7 +87,7 @@ If you find a security issue, please email security@bitpay.com.
|
|||
|
||||
## Contributing
|
||||
|
||||
Please send pull requests for bug fixes, code optimization, and ideas for improvement. For more information on how to contribute, please refer to our [CONTRIBUTING](https://github.com/bitpay/bitcore/blob/master/CONTRIBUTING.md) file.
|
||||
Please send pull requests for bug fixes, code optimization, and ideas for improvement. For more information on how to contribute, please refer to our [CONTRIBUTING](https://github.com/bitpay/bitcore/blob/master/CONTRIBUTING.md) file.
|
||||
|
||||
## Building the Browser Bundle
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue