From 85b0e3fce3ef53b3ed66733df38701b5d8b72bca Mon Sep 17 00:00:00 2001 From: Lloyd Hilaiel Date: Mon, 5 Nov 2012 23:35:26 -0700 Subject: [PATCH] document theory of operation for client libraries that live here --- client/README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 client/README.md diff --git a/client/README.md b/client/README.md new file mode 100644 index 0000000..6a3c093 --- /dev/null +++ b/client/README.md @@ -0,0 +1,14 @@ +Here lives javascript code designed to run on the client. This includes: + + * `sjcl.js` - the awesome Stanford Javascript Crypto Library + * `crypto.js` - a small Gombot specific wrapper around SJCL that holds constants used in the product and exposes a small, focused high level API. Designed to be run on both the client and server. + * `client.js` - a small networking library that abstracts clients from protocol details. used on both client and server. + +## Usage + +Read the source for the API, have a look at `../tests/*` which are the primary clients of these libraries in this tree. Then: + + 1. `cat sjcl.js crypto.js client.js > client_lib.js` + 2. include that in your addon + 3. call its api to do stuff +