Skip to content

Latest commit

 

History

History
37 lines (23 loc) · 1.47 KB

README.md

File metadata and controls

37 lines (23 loc) · 1.47 KB
Raw

#ripple-lib

A JavaScript API for interacting with Ripple in Node.js

Circle CI Coverage Status

NPM

###Features

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

##Getting Started

Install ripple-lib using npm:

  $ npm install ripple-lib

Then see the documentation and code samples

##Running tests

  1. Clone the repository
  2. cd into the repository and install dependencies with npm install
  3. npm test or npm test --coverage (istanbul will create coverage reports in coverage/lcov-report/`)

##Generating Documentation

The continuous integration tests require that the documentation stays up-to-date. If you make changes to the JSON schemas, fixtures, or documentation sources, you must update the documentation by running npm run docgen.

##More Information