document theory of operation for client libraries that live here

This commit is contained in:
Lloyd Hilaiel 2012-11-05 23:35:26 -07:00
Родитель 4d9f2fdecf
Коммит 85b0e3fce3
1 изменённых файлов: 14 добавлений и 0 удалений

14
client/README.md Normal file
Просмотреть файл

@ -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