Jeff Burke | e29f2af | 2012-12-08 12:15:22 -0800 | [diff] [blame] | 1 | NDN.JS: A javascript client library for Named Data Networking |
Jeff Burke | 0f418d0 | 2012-12-08 12:14:41 -0800 | [diff] [blame] | 2 | |
Jeff Burke | acb3b3d | 2012-12-08 12:17:41 -0800 | [diff] [blame] | 3 | BASIC LIBRARY: NO BUILD REQUIRED. |
| 4 | The basic NDN.JS library does not need to be "built". For the library, you can manually |
| 5 | include the necessary scripts in a web page or include Helper.js to have it load all of |
| 6 | the scripts. |
Jeff Burke | 0f418d0 | 2012-12-08 12:14:41 -0800 | [diff] [blame] | 7 | |
Jeff Burke | acb3b3d | 2012-12-08 12:17:41 -0800 | [diff] [blame] | 8 | BUILD A COMBINED, COMPRESSED LIBRARY. |
Jeff Burke | e29f2af | 2012-12-08 12:15:22 -0800 | [diff] [blame] | 9 | A more efficient way to include the library is to used the combined, compressed library |
| 10 | ndn-js.js that can be made using the js/tools/build/make-js.sh script. See the README in |
| 11 | that directly. While we try to keep a built version in that directory for convenience, it |
| 12 | may fall out of sync with the library, so we recommend building it using the script if |
| 13 | possible. |
| 14 | |
Jeff Burke | acb3b3d | 2012-12-08 12:17:41 -0800 | [diff] [blame] | 15 | WEBSOCKETS PROXY. |
Jeff Burke | e29f2af | 2012-12-08 12:15:22 -0800 | [diff] [blame] | 16 | If you wish to run your own WebSockets proxy instead of using the NDN testbed, you must |
| 17 | build and install Node.js (often on the machine also running the ccnd you wish to proxy |
Jeff Burke | 9c950af | 2012-12-08 12:18:54 -0800 | [diff] [blame] | 18 | for, but that doesn't have to be the case). See wsproxy/README.md |
Jeff Burke | 0f418d0 | 2012-12-08 12:14:41 -0800 | [diff] [blame] | 19 | |
Jeff Thompson | 4c6d92c | 2012-12-09 12:51:25 -0800 | [diff] [blame] | 20 | THE FIREFOX ADD-ON. |
| 21 | If the compressed library js/tools/build/ndn-js.js is out of date, first build it (see above). |
| 22 | Go to js/ndnProtocol and run make-ndnProtocol.sh which makes js/ndnProtocol.xpi . |