ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-11-04 21:15:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
1f3eb57fa46bba42e86704f980deecab1fbf8cf1
xahau.js/README.md
Evan Schwartz 1f3eb57fa4 added REFERENCE and GUIDES
2013-09-06 15:12:32 -07:00

1.1 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.

##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
  3. Additional documentation resources can be found at:

##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 next section for available options
  trusted:        true,
  local_signing:  true,
  local_fee:      true,
  servers: [
    {
        host:    's1.ripple.com'
      , port:    443,
      , secure:  true
    }
  ]
});

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