From 8f2d0089df225e29ca7d20d7062f6c68d56b1988 Mon Sep 17 00:00:00 2001 From: Braydon Fuller Date: Mon, 16 Mar 2015 13:50:50 -0400 Subject: [PATCH] updated readme and fixed image scaling issue --- README.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 4e7d7ae..2dfc7be 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ -bitcore payment protocol -P2P Networking capabilities for bitcore +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-p2p adds support for connecting to the bitcoin p2p network in [Node.js](http://nodejs.org/). +`bitcore-p2p` adds [Bitcoin protocol](https://en.bitcoin.it/wiki/Protocol_documentation) support for Bitcore. See [the main bitcore repo](https://github.com/bitpay/bitcore) for more information. @@ -15,12 +15,12 @@ See [the main bitcore repo](https://github.com/bitpay/bitcore) for more informat ```sh npm install bitcore-p2p ``` -In order to connect to the bitcore network, you'll need to know the IP address of at least one node of the network. You can do that by using the known DNS servers. Then, you can connect to it: +In order to connect to the Bitcoin network, you'll need to know the IP address of at least one node of the network, or use [Pool](/docs/pool.md) to discover peers using a DNS seed. ```javascript var Peer = require('bitcore-p2p').Peer; -var peer = new Peer('0.0.0.0'); +var peer = new Peer({host: '127.0.0.1'}); peer.on('ready', function() { // peer info @@ -55,4 +55,3 @@ See [CONTRIBUTING.md](https://github.com/bitpay/bitcore) on the main bitcore rep Code released under [the MIT license](https://github.com/bitpay/bitcore/blob/master/LICENSE). Copyright 2013-2015 BitPay, Inc. Bitcore is a trademark maintained by BitPay, Inc. -