From 6361201862ed84bf3dbcb36a7dea26eefdbb1843 Mon Sep 17 00:00:00 2001 From: Braydon Fuller Date: Thu, 15 Oct 2015 20:37:34 -0400 Subject: [PATCH] Update README to start a full node. --- .jsdoc.conf | 36 ------------------------- README.md | 75 ++++++++++++++++++++++++++++++++--------------------- 2 files changed, 45 insertions(+), 66 deletions(-) delete mode 100644 .jsdoc.conf diff --git a/.jsdoc.conf b/.jsdoc.conf deleted file mode 100644 index a6a59aa40..000000000 --- a/.jsdoc.conf +++ /dev/null @@ -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 -} - -} diff --git a/README.md b/README.md index 2824b4604..268fe1627 100644 --- a/README.md +++ b/README.md @@ -5,30 +5,59 @@ Bitcore [![Build Status](https://img.shields.io/travis/bitpay/bitcore.svg?branch=master&style=flat-square)](https://travis-ci.org/bitpay/bitcore) [![Coverage Status](https://img.shields.io/coveralls/bitpay/bitcore.svg?style=flat-square)](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 --------|---------|----------|--------- -bitcore-payment-protocol | [![NPM Package](https://img.shields.io/npm/v/bitcore-payment-protocol.svg?style=flat-square)](https://www.npmjs.org/package/bitcore-payment-protocol) | [![Build Status](https://img.shields.io/travis/bitpay/bitcore-payment-protocol.svg?branch=master&style=flat-square)](https://travis-ci.org/bitpay/bitcore-payment-protocol) | [![Coverage Status](https://img.shields.io/coveralls/bitpay/bitcore-payment-protocol.svg?style=flat-square)](https://coveralls.io/r/bitpay/bitcore-payment-protocol) -bitcore-p2p | [![NPM Package](https://img.shields.io/npm/v/bitcore-p2p.svg?style=flat-square)](https://www.npmjs.org/package/bitcore-p2p) | [![Build Status](https://img.shields.io/travis/bitpay/bitcore-p2p.svg?branch=master&style=flat-square)](https://travis-ci.org/bitpay/bitcore-p2p) | [![Coverage Status](https://img.shields.io/coveralls/bitpay/bitcore-p2p.svg?style=flat-square)](https://coveralls.io/r/bitpay/bitcore-p2p?branch=master) -bitcore-mnemonic | [![NPM Package](https://img.shields.io/npm/v/bitcore-mnemonic.svg?style=flat-square)](https://www.npmjs.org/package/bitcore-mnemonic) | [![Build Status](https://img.shields.io/travis/bitpay/bitcore-mnemonic.svg?branch=master&style=flat-square)](https://travis-ci.org/bitpay/bitcore-mnemonic) | [![Coverage Status](https://img.shields.io/coveralls/bitpay/bitcore-mnemonic.svg?style=flat-square)](https://coveralls.io/r/bitpay/bitcore-mnemonic) -bitcore-ecies | [![NPM Package](https://img.shields.io/npm/v/bitcore-ecies.svg?style=flat-square)](https://www.npmjs.org/package/bitcore-ecies) | [![Build Status](https://img.shields.io/travis/bitpay/bitcore-ecies.svg?branch=master&style=flat-square)](https://travis-ci.org/bitpay/bitcore-ecies) | [![Coverage Status](https://img.shields.io/coveralls/bitpay/bitcore-ecies.svg?style=flat-square)](https://coveralls.io/r/bitpay/bitcore-ecies) -bitcore-channel | [![NPM Package](https://img.shields.io/npm/v/bitcore-channel.svg?style=flat-square)](https://www.npmjs.org/package/bitcore-channel) | [![Build Status](https://img.shields.io/travis/bitpay/bitcore-channel.svg?branch=master&style=flat-square)](https://travis-ci.org/bitpay/bitcore-channel) | [![Coverage Status](https://img.shields.io/coveralls/bitpay/bitcore-channel.svg?style=flat-square)](https://coveralls.io/r/bitpay/bitcore-channel) -bitcore-explorers | [![NPM Package](https://img.shields.io/npm/v/bitcore-explorers.svg?style=flat-square)](https://www.npmjs.org/package/bitcore-explorers) | [![Build Status](https://img.shields.io/travis/bitpay/bitcore-explorers.svg?branch=master&style=flat-square)](https://travis-ci.org/bitpay/bitcore-explorers) | [![Coverage Status](https://img.shields.io/coveralls/bitpay/bitcore-explorers.svg?style=flat-square)](https://coveralls.io/r/bitpay/bitcore-explorers) -bitcore-message | [![NPM Package](https://img.shields.io/npm/v/bitcore-message.svg?style=flat-square)](https://www.npmjs.org/package/bitcore-message) | [![Build Status](https://img.shields.io/travis/bitpay/bitcore-message.svg?branch=master&style=flat-square)](https://travis-ci.org/bitpay/bitcore-message) | [![Coverage Status](https://img.shields.io/coveralls/bitpay/bitcore-message.svg?style=flat-square)](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