ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-11-19 11:45:49 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
4886561f7dd6e1b08530db323a1dcf898a2041d0
xahau.js/README.md
mDuo13 d3332e0db9 README updates for rebranding
2017-07-31 17:17:30 -07:00

1.6 KiB
Raw Blame History

ripple-lib

A JavaScript API for interacting with the XRP Ledger

Circle CI Coverage Status

NPM

Features

  • Connect to a rippled server from Node.js or a web browser
  • Issue rippled API requests
  • Listen to events on the XRP Ledger (transaction, ledger, etc.)
  • Sign and submit transactions to the XRP Ledger

Getting Started

See also: RippleAPI Beginners Guide

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