ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-11-19 11:45:49 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
92464495907c2c163cc0db0cdcc10c555b82c9aa
xahau.js/README.md
Evan Schwartz 9246449590 editing docs
2013-09-06 17:05:21 -07:00

1.5 KiB
Raw Blame History

#The Ripple JavaScript Library

ripple-lib connects to the Ripple network via the WebSocket protocol and runs in Node.js as well as in the browser.

This file contains installation and quickstart instructions.

For additional documentation see:

  1. The ripple-lib Guides
  2. The ripple-lib API Reference
  3. The Ripple Wiki:

##Getting ripple-lib

  1. Via npm for Node.js: npm install ripple-lib
  2. Build from the source using grunt and load the minified ripple-#.#.#-min.js into your webpage

##Quickstart

Remote (remote.js) is the module responsible for managing connections to rippled servers:

/* 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
  trusted:        true,
  local_signing:  true,
  local_fee:      true,
  fee_cusion:     1.5,
  servers: [
    {
        host:    's1.ripple.com'
      , port:    443,
      , secure:  true
    }
  ]
});

remote.connect(function() {
  /* remote connected */

  // see the API Reference for available functions
});

See The ripple-lib Guides and The ripple-lib API Reference for walkthroughs and details about all of the available functions and options.