From 0ce98b126ff50bfe2ca4cc81e25de4165cb12e91 Mon Sep 17 00:00:00 2001 From: Evan Schwartz Date: Fri, 6 Sep 2013 17:24:38 -0700 Subject: [PATCH] small edit to the using remote guide --- README.md | 6 +++--- docs/GUIDES.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f4972651..8692a194 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,8 @@ ###For additional documentation see: -1. [The `ripple-lib` Guides](docs/GUIDES.md) -2. [The `ripple-lib` API Reference](docs/REFERENCE.md) +1. [The `ripple-lib` Guides (docs/GUIDES.md)](docs/GUIDES.md) +2. [The `ripple-lib` API Reference (docs/REFERENCE.md)](docs/REFERENCE.md) 3. https://ripple.com/wiki/Ripple_JavaScript_library ###Also see: @@ -58,4 +58,4 @@ remote.connect(function() { }); ``` -See [The `ripple-lib` Guides](docs/REFERENCE.md) and [The `ripple-lib` API Reference](docs/REFERENCE.md) for walkthroughs and details about all of the available functions and options. +See [The `ripple-lib` Guides](docs/GUIDES.md) and [The `ripple-lib` API Reference](docs/REFERENCE.md) for walkthroughs and details about all of the available functions and options. diff --git a/docs/GUIDES.md b/docs/GUIDES.md index 73006abc..008cafde 100644 --- a/docs/GUIDES.md +++ b/docs/GUIDES.md @@ -38,7 +38,7 @@ ##2. Using `Remote` functions and `Request` objects -Each remote function returns a `Request` object, which is an `EventEmitter`. You can listen for success or failure events from each request or, alternatively, you can provide a callback. +Each remote function returns a `Request` object. A `Request` is an `EventEmitter`, meaning that you can listen for success or failure events or you can instead provide a callback to the `Remote` function. Here is an example, using `request_server_info()`, of how `Remote` functions can be used with event listeners (the first code block) or with a callback (the second block):