Update references of npm to yarn

README.md

@@ -17,9 +17,13 @@ A JavaScript API for interacting with the XRP Ledger
 
 See also: [RippleAPI Beginners Guide](https://ripple.com/build/rippleapi-beginners-guide/)
 
-Install `ripple-lib` using npm:
+You can use `npm`, but we recommend using `yarn` for the added assurance provided by `yarn.lock`.
+
++ [Yarn Installation Instructions](https://yarnpkg.com/en/docs/install)
+
+Install `ripple-lib`:
 ```
-$ npm install ripple-lib
+$ yarn 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)
@@ -27,12 +31,14 @@ Then see the [documentation](https://github.com/ripple/ripple-lib/blob/develop/d
 ## 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/`)
+2. `cd` into the repository and install dependencies with `yarn install`
+3. `yarn test` or `yarn 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`.
+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 `yarn run docgen`.
+
+`npm` may be used instead of `yarn` in the commands above.
 
 ## More Information
 

docs/index.md

@@ -155,9 +155,9 @@ If you omit the `server` parameter, RippleAPI operates [offline](#offline-functi
 
 ### Installation ###
 
-1. Install [Node.js](https://nodejs.org) and the Node Package Manager (npm). Most Linux distros have a package for Node.js; check that it's the version you want.
-2. Use npm to install RippleAPI:
-      `npm install ripple-lib`
+1. Install [Node.js](https://nodejs.org) and [Yarn](https://yarnpkg.com/en/docs/install). Most Linux distros have a package for Node.js; check that it's the version you want.
+2. Use yarn to install RippleAPI:
+      `yarn install ripple-lib`
 
 After you have installed ripple-lib, you can create scripts using the [boilerplate](#boilerplate) and run them using the Node.js executable, typically named `node`:
 
@@ -2754,7 +2754,22 @@ return api.getSettings(address).then(settings =>
   "disallowIncomingXRP": true,
   "emailHash": "23463B99B62A72F26ED677CC556C44E8",
   "domain": "example.com",
-  "transferRate": 1.002
+  "transferRate": 1.002,
+  "signers": {
+    "threshold": 3,
+    "weights": [
+      {
+        "address": "rpHit3GvUR1VSGh2PXcaaZKEEUnCVxWU2i",
+        "weight": 1
+      }, {
+        "address": "rN4oCm1c6BQz6nru83H52FBSpNbC9VQcRc",
+        "weight": 1
+      }, {
+        "address": "rJ8KhCi67VgbapiKCQN3r1ZA6BMUxUvvnD",
+        "weight": 1
+      }
+    ]
+  }
 }
 ```
 

docs/src/boilerplate.md.ejs

@@ -53,9 +53,9 @@ If you omit the `server` parameter, RippleAPI operates [offline](#offline-functi
 
 ### Installation ###
 
-1. Install [Node.js](https://nodejs.org) and the Node Package Manager (npm). Most Linux distros have a package for Node.js; check that it's the version you want.
-2. Use npm to install RippleAPI:
-      `npm install ripple-lib`
+1. Install [Node.js](https://nodejs.org) and [Yarn](https://yarnpkg.com/en/docs/install). Most Linux distros have a package for Node.js; check that it's the version you want.
+2. Use yarn to install RippleAPI:
+      `yarn install ripple-lib`
 
 After you have installed ripple-lib, you can create scripts using the [boilerplate](#boilerplate) and run them using the Node.js executable, typically named `node`:
 

scripts/publish

@@ -7,12 +7,12 @@ function exit_on_error {
 
 rm -rf build
 
-npm install
+yarn install
 gulp
-npm test
+yarn test
 exit_on_error
 
 echo ""
 echo "publish to npm"
-npm publish
+yarn publish
 exit_on_error

scripts/publish_rc

@@ -7,12 +7,12 @@ function exit_on_error {
 
 rm -rf build
 
-npm install
+yarn install
 gulp
-npm test
+yarn test
 exit_on_error
 
 echo ""
 echo "publish rc to npm"
-npm publish --tag beta
+yarn publish --tag beta
 exit_on_error