| commit | a273f137eb7daaa05106900e2503d26055731edf | [log] [tgz] |
|---|---|---|
| author | Adam Sadovsky <asadovsky@gmail.com> | Thu Oct 08 19:42:20 2015 -0700 |
| committer | Adam Sadovsky <asadovsky@gmail.com> | Thu Oct 08 19:42:20 2015 -0700 |
| tree | 582fd635d76e5be85b68597a50ba9ff2583e4d51 | |
| parent | 5cc1a83f730a7d002f1113594b8930e8e8268491 [diff] |
TBR: js.syncbase: syncbase: s/yncGroup/yncgroup/
With this change, we establish a convention of treating
"syncgroup" as a single, common (non-proper) noun.
The main motivation for this change was consistency, for
a term that's used widely across our codebase and docs.
Arguments for "Syncgroup" over "SyncGroup" were:
- it's "Syncbase", not "SyncBase"
- we'd probably like to use "syncgroup" rather than
"sync_group" in snake-case text, e.g. in filenames like
"syncgroup_test.go"; using "SyncGroup" for camel-case
text would make these two inconsistent (Nick pointed
this out)
- avoids ambiguity about capitalization at the start of a
sentence vs. inside a sentence ("SyncGroup" vs.
"syncgroup"?)
(Note, I discussed this change with Bindu, Raja, and Nick
before making it.)
I mainly used 'find -exec perl -pi -e' to prepare this
change, plus manual inspection and tweaks. The main
painful part was updating lots of comments in the Syncbase
implementation to use "syncgroup" instead of "Syncgroup"
where that was the intended usage.
MultiPart: 6/11
Change-Id: Ifb53c6d6004759391278daf438dc7032f573326f
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.
npm install --save vanadium/js.syncbase
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 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