diff --git a/examples/js_client/README.md b/examples/js_client/README.md new file mode 100644 index 00000000..26cf5c97 --- /dev/null +++ b/examples/js_client/README.md @@ -0,0 +1,16 @@ +# Hot Pocket javascript client library and examples + +Single-file javascript library to support json and bson protocols in NodeJs and Browser environments. + +## NodeJs +1. Run `npm install` to install all the dependencies. +1. `lib/hp-client-lib.js` is the Hot Pocket client library for NodeJs. +1. `text-client.js` is the example for json mode. +1. `file-client.js` is the example for bson mode. + +## Browser +1. Run `npm install` to install all the compilation dependencies. +1. Run `npm run build-browser` to produced the minified library for the browser. +1. `browser-example.html` is the simple html/javascript example for json mode. + +(For BSON support in browser, a slightly modified version of https://www.npmjs.com/package/bson is used. The minified library includes this bson support library as well) \ No newline at end of file diff --git a/examples/js_client/browser-example.html b/examples/js_client/browser-example.html index a8b157b6..fb127588 100644 --- a/examples/js_client/browser-example.html +++ b/examples/js_client/browser-example.html @@ -3,19 +3,14 @@