| commit | d4c65debdcf3494935943d4af36abca6082ed552 | [log] [tgz] |
|---|---|---|
| author | Jing Jin <jingjin@google.com> | Tue Sep 08 10:33:14 2015 -0700 |
| committer | Jing Jin <jingjin@google.com> | Tue Sep 08 10:33:14 2015 -0700 |
| tree | b246f69994ba42a64ec4344b8933ae66769fcac3 | |
| parent | 85dd8d0076a4150b85d937c0a9780b1f65f75e95 [diff] |
javascript/syncbase: Setup jsdoc for syncbase. I copied Makefile targets from core and modified them a little bit. I also copied "jsdocs" content from core, and cleaned up index.md. MultiPart: 1/3 Change-Id: I7e6e4f776b85c517e71002161a8aa564f23be3e5
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.
Since Vanadium is currently hosted in private repositories, you would need to [setup SSH keys for Github] (https://help.github.com/articles/generating-ssh-keys/) first and then use npm to install directly from GitHub:
npm install --save git+ssh://git@github.com:vanadium/js.syncbase.git
currently vanadium.js needs to be installed manually as well:
npm install --save git+ssh://git@github.com:vanadium/js.git
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, sycnbase expects that the vanadium extension will be installed.
Bugs and feature requests should be filed in the Vanadium issue tracker.
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