diff --git a/README.md b/README.md index d97c846f..60d1eaa8 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # ripple-lib -A JavaScript API for interacting with Ripple in Node.js +A JavaScript API for interacting with the XRP Ledger [![Circle CI](https://circleci.com/gh/ripple/ripple-lib/tree/develop.svg?style=svg)](https://circleci.com/gh/ripple/ripple-lib/tree/develop) [![Coverage Status](https://coveralls.io/repos/ripple/ripple-lib/badge.png?branch=develop)](https://coveralls.io/r/ripple/ripple-lib?branch=develop) @@ -8,16 +8,18 @@ A JavaScript API for interacting with Ripple in Node.js ### Features -+ Connect to a rippled server in Node.js ++ 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 Ripple network (transaction, ledger, etc.) -+ Sign and submit transactions to the Ripple network ++ 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 +$ 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) @@ -26,7 +28,7 @@ Then see the [documentation](https://github.com/ripple/ripple-lib/blob/develop/d 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/`) +3. `npm test` or `npm test --coverage` (`istanbul` will create coverage reports in `coverage/lcov-report/`) ## Generating Documentation @@ -34,4 +36,4 @@ The continuous integration tests require that the documentation stays up-to-date ## More Information -+ [Ripple Dev Portal](https://ripple.com/build/) ++ [Ripple Developer Center](https://ripple.com/build/)