diff options
| author | Bernard Normier <bernard@zeroc.com> | 2017-07-18 12:31:43 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-07-18 12:31:43 -0400 |
| commit | df36974a4286fb2f59192c7f8bd32e6948fe7735 (patch) | |
| tree | 40bf66bfff9abc0f789f746223dbe2cecc5fc1c6 | |
| parent | ES fixes (diff) | |
| download | ice-df36974a4286fb2f59192c7f8bd32e6948fe7735.tar.bz2 ice-df36974a4286fb2f59192c7f8bd32e6948fe7735.tar.xz ice-df36974a4286fb2f59192c7f8bd32e6948fe7735.zip | |
Updated README
| -rw-r--r-- | js/README.md | 18 |
1 files changed, 10 insertions, 8 deletions
diff --git a/js/README.md b/js/README.md index e7f60949e48..082779d8891 100644 --- a/js/README.md +++ b/js/README.md @@ -1,11 +1,11 @@ -# Internet Communications Engine (Ice) -Ice is a comprehensive RPC framework with support for C++, .NET, Java, Python, JavaScript and more. +# Ice for JavaScript +Ice is a comprehensive RPC framework with support for JavaScript, C++, .NET, Java, Python and more. ## Install Using npm: ```bash -$ npm install ice --save +npm install ice --save ``` ## Usage @@ -20,7 +20,8 @@ var communicator = Ice.initialize(process.argv); var proxy = communicator.stringToProxy("hello:tcp -h localhost -p 10000"); ``` -The npm package also includes the browser version of Ice for JavaScript. Add the necessary `<script>` tags to your html to include the Ice for JavaScript components you require. `node_modules` must server out from the root directory of your web server. +The npm package also includes the browser version of Ice for JavaScript. Add `<script>` +tags to your html to include the Ice for JavaScript components you require. For example: ```html <script src="/node_modules/ice/lib/Ice.js"></script> @@ -37,14 +38,15 @@ Minified versions are available with the `.min.js` extension. ## Documentation -See the [Ice Documentation](https://doc.zeroc.com/display/Ice37/JavaScript+Mapping). +See the [Ice Manual](https://doc.zeroc.com/display/Ice37/Ice+Manual). -## Slice2js Compiler +## Compiling Slice Files to JavaScript -To compile [Slice](https://doc.zeroc.com/display/Ice37/The+Slice+Language) files to JavaScript see the following: +You can use `slice2js` directly or through the Ice Builder for Gulp to compile Slice files to JavaScript: - [slice2js](https://github.com/zeroc-ice/npm-slice2js) - [gulp-ice-builder](https://github.com/zeroc-ice/gulp-ice-builder) ## Demos -A collection of demos for Ice for JavaScript (and other language mappings) can be found [here](https://github.com/zeroc-ice/ice-demos). +The [ice-demos](https://github.com/zeroc-ice/ice-demos) repository provides a collection of demos for +JavaScript and other programming languages. |