blob: 45de26049f0ac8563f03a8be2ab922935bb159b6 [file] [log] [blame]
Jeff Burkee29f2af2012-12-08 12:15:22 -08001NDN.JS: A javascript client library for Named Data Networking
Jeff Burke0f418d02012-12-08 12:14:41 -08002
Jeff Burkeacb3b3d2012-12-08 12:17:41 -08003BASIC LIBRARY: NO BUILD REQUIRED.
4The basic NDN.JS library does not need to be "built". For the library, you can manually
5include the necessary scripts in a web page or include Helper.js to have it load all of
6the scripts.
Jeff Burke0f418d02012-12-08 12:14:41 -08007
Jeff Burkeacb3b3d2012-12-08 12:17:41 -08008BUILD A COMBINED, COMPRESSED LIBRARY.
Jeff Burkee29f2af2012-12-08 12:15:22 -08009A more efficient way to include the library is to used the combined, compressed library
10ndn-js.js that can be made using the js/tools/build/make-js.sh script. See the README in
11that directly. While we try to keep a built version in that directory for convenience, it
12may fall out of sync with the library, so we recommend building it using the script if
13possible.
14
Jeff Burkeacb3b3d2012-12-08 12:17:41 -080015WEBSOCKETS PROXY.
Jeff Burkee29f2af2012-12-08 12:15:22 -080016If you wish to run your own WebSockets proxy instead of using the NDN testbed, you must
17build and install Node.js (often on the machine also running the ccnd you wish to proxy
Jeff Burke9c950af2012-12-08 12:18:54 -080018for, but that doesn't have to be the case). See wsproxy/README.md
Jeff Burke0f418d02012-12-08 12:14:41 -080019
Jeff Thompson4c6d92c2012-12-09 12:51:25 -080020THE FIREFOX ADD-ON.
21If the compressed library js/tools/build/ndn-js.js is out of date, first build it (see above).
22Go to js/ndnProtocol and run make-ndnProtocol.sh which makes js/ndnProtocol.xpi .