mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-19 19:55:51 +00:00
40 lines
1.6 KiB
Markdown
40 lines
1.6 KiB
Markdown
# ripple-lib
|
|
|
|
A JavaScript API for interacting with the XRP Ledger
|
|
|
|
[](https://circleci.com/gh/ripple/ripple-lib/tree/develop) [](https://coveralls.io/r/ripple/ripple-lib?branch=develop)
|
|
|
|
[](https://www.npmjs.org/package/ripple-lib)
|
|
|
|
### Features
|
|
|
|
+ Connect to a `rippled` server from Node.js or a web browser
|
|
+ Issue [rippled API](https://ripple.com/build/rippled-apis/) 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](https://ripple.com/build/rippleapi-beginners-guide/)
|
|
|
|
Install `ripple-lib` using npm:
|
|
```
|
|
$ npm install ripple-lib
|
|
```
|
|
|
|
Then see the [documentation](https://github.com/ripple/ripple-lib/blob/develop/docs/index.md) and [code samples](https://github.com/ripple/ripple-lib/tree/develop/docs/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
|
|
|
|
+ [Ripple Developer Center](https://ripple.com/build/)
|