Update README for RippleAPI

README.md

@@ -13,88 +13,21 @@ A JavaScript API for interacting with Ripple in Node.js and the browser
 + Listen to events on the Ripple network (transaction, ledger, etc.)
 + Sign and submit transactions to the Ripple network
 
-###In this file
+##Getting Started
-
-1. [Installation](#installation)
-2. [Quick start](#quick-start)
-3. [Running tests](#running-tests)
-
-###Additional documentation
-
-1. [Guides](docs/GUIDES.md)
-2. [API Reference](docs/REFERENCE.md)
-3. [Wiki](https://ripple.com/wiki/Ripple_JavaScript_library)
-
-###Also see
-
-+ [The Ripple wiki](https://ripple.com/wiki)
-+ [ripple.com](https://ripple.com)
-
-##Installation
-
-**Via npm for Node.js**
 
+Install `ripple-lib` using npm:
 ```
   $ npm install ripple-lib
 ```
 
-**Via bower (for browser use)**
+Then see the sample code in `docs/samples`.
-
-```
-  $ bower install ripple
-```
-
-See the [bower-ripple repo](https://github.com/ripple/bower-ripple) for additional bower instructions.
-
-
-**Building ripple-lib for browser environments**
-
-ripple-lib uses Gulp to generate browser builds. These steps will generate minified and non-minified builds of ripple-lib in the `build/` directory.
-
-```
-  $ git clone https://github.com/ripple/ripple-lib
-  $ npm install
-  $ npm run build
-```
-
-**Restricted browser builds**
-
-You may generate browser builds that contain a subset of features. To do this, run `./node_modules/.bin/gulp build-<name>`
-
-+ `build-core` Contains the functionality to make requests and listen for events such as `ledgerClose`. Only `ripple.Remote` is currently exposed. Advanced features like transaction submission and orderbook tracking are excluded from this build.
-
-##Quick start
-
-`Remote.js` ([remote.js](https://github.com/ripple/ripple-lib/blob/develop/src/js/ripple/remote.js)) is the point of entry for interacting with rippled
-
-```js
-/* Loading ripple-lib with Node.js */
-var Remote = require('ripple-lib').Remote;
-
-/* Loading ripple-lib in a webpage */
-// var Remote = ripple.Remote;
-
-var remote = new Remote({
-  // see the API Reference for available options
-  servers: [ 'wss://s1.ripple.com:443' ]
-});
-
-remote.connect(function() {
-  /* remote connected */
-  remote.requestServerInfo(function(err, info) {
-    // process err and info
-  });
-});
-```
 
 ##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/`)
 
-3. `npm test`
+##More Information
 
-**Generating code coverage**
++ [Ripple Dev Portal](https://ripple.com/build/)
-
-ripple-lib uses `istanbul` to generate code coverage. To create a code coverage report, run `npm test --coverage`. The report will be created in `coverage/lcov-report/`.

test/api-test.js

@@ -91,8 +91,10 @@ describe('RippleAPI', function() {
   });
 
   it('prepareOrderCancellation', function() {
-    return this.api.prepareOrderCancellation(address, 23, instructions).then(
+    const request = requests.prepareOrderCancellation;
-      _.partial(checkResult, responses.prepareOrderCancellation, 'prepare'));
+    return this.api.prepareOrderCancellation(address, request, instructions)
+      .then(_.partial(checkResult, responses.prepareOrderCancellation,
+        'prepare'));
   });
 
   it('prepareTrustline - simple', function() {

test/fixtures/requests/index.js

@@ -6,6 +6,7 @@ module.exports = {
     sell: require('./prepare-order-sell'),
     expiration: require('./prepare-order-expiration')
   },
+  prepareOrderCancellation: require('./prepare-order-cancellation'),
   preparePayment: require('./prepare-payment'),
   preparePaymentAllOptions: require('./prepare-payment-all-options'),
   preparePaymentNoCounterparty: require('./prepare-payment-no-counterparty'),

test/fixtures/requests/prepare-order-cancellation.json

@@ -0,0 +1 @@
+23