README.md

#ripple-lib

JavaScript client for rippled

###Features

• Connect to a rippled server in JavaScript (Node.js or browser)
• Issue rippled API requests
• Listen to events on the Ripple network (transaction, ledger, etc.)
• Sign and submit transactions to the Ripple network

###In this file

1. Installation
2. Quickstart
3. Running tests

###Additional documentation

1. Guides
2. API Reference
3. Wiki

###Also see

• The Ripple wiki
• ripple.com

##Installation

Via npm for Node.js

  $ npm install ripple-lib

Via bower (for browser use)

  $ bower install ripple

See the bower-ripple repo for additional bower instructions

Building ripple-lib from github

  $ git clone https://github.com/ripple/ripple-lib
  $ npm install
  $ npm run build

Then use the minified build/ripple-*-min.js

##Quickstart

Remote.js (remote.js) is the point of entry for interacting with rippled

/* Loading ripple-lib with Node.js */
var Remote = require('ripple-lib').Remote;

/* Loading ripple-lib in a webpage */
// var Remote = ripple.Remote;

var remote = new Remote({
  // see the API Reference for available options
  servers: [ 'wss://s1.ripple.com:443' ]
});

remote.connect(function() {
  /* remote connected */
  remote.request('server_info', function(err, info) {

  });
});

##Running tests

1. Clone the repository

2. cd into the repository and install dependencies with npm install

3. npm test or node_modules/.bin/mocha test/*-test.js

Generating code coverage

ripple-lib uses istanbul to generate code coverage. To create a code coverage report, run npm test --coverage. The report will be created in coverage/lcov-report/.