Google Git
Sign in
vanadium / release.js.syncbase / 98fd386bfcc919660b58ec57d59ce097bb6ce6c3
commit98fd386bfcc919660b58ec57d59ce097bb6ce6c3[log] [tgz]
authorNicolas Lacasse <nlacasse@google.com>Tue Mar 08 12:48:31 2016 -0800
committerNicolas Lacasse <nlacasse@google.com>Tue Mar 08 21:21:36 2016 +0000
tree6254039a7e4648b76f5a38759f5b2e89bf9db9bf
parentc5d6c41888b6675a651535faf435e3da01281e87 [diff]
TBR: Use "node npm" rather than calling "npm" directly.

Change-Id: I06ed96bf2d6f8de2b020b6a270fbfdb78b222288
1 file changed
tree: 6254039a7e4648b76f5a38759f5b2e89bf9db9bf
  1. jsdocs/
  2. src/
  3. test/
  4. .gitignore
  5. .jshintignore
  6. .jshintrc
  7. AUTHORS
  8. CONTRIBUTING.md
  9. CONTRIBUTORS
  10. LICENSE
  11. Makefile
  12. package.json
  13. PATENTS
  14. README.md
  15. VERSION
README.md

Syncbase JavaScript Client

This repository defines the JavaScript API for Syncbase, a structured store that supports peer-to-peer synchronization.

The client APIs defined here work both in Node.js and the browser.

Install

npm install --save vanadium/js.syncbase

Usage

Documentation for this API is [TODO(aghassemi)](LINK TO JS DOCUMENTATION)

Tutorials can be found at [TODO(aghassemi)](LINK TO JS TUTORIAL FOR SYNCBASE)

The entry point to the API is through a module called syncbase, everything else is considered private and should not be accessed by the users of the API.

When using Browserify or Node.js users can gain access to the API with:

var syncbase = require("syncbase");

When run in a browser, syncbase expects that the vanadium extension will be installed.

Bugs and feature requests

Bugs and feature requests should be filed in the Vanadium issue tracker.

Building and testing

GNU Make is used to build and test Syncbase.

Build everything:

make

Test everything:

make test

Run a specific test suite:

make test-integration
make test-integration-node
make test-integration-browser

Remove all build and testing artifacts:

make clean