Skip to content

Latest commit

 

History

History
49 lines (29 loc) · 1.34 KB

README.md

File metadata and controls

49 lines (29 loc) · 1.34 KB
Raw

Vortex JavaScript Connector

JavaScript connector for the Vortex JavaScript Editor.

Licensed under the MIT License.

##About

This JavaScript library is the counterpart of the Vortex JavaScript Editor.

For more information on what it is visit the Vortex JavaScript Editor project.

##Usage

Download a build from here.

Load the Vortex JavaScript library.

<script src="vortex.js" type="text/javascript"></script>

Create an instance of the Vortex class.

<script>
    var vortexConnector=new vortex({
        host: '127.0.0.1',
        port: 8081,
        listener: {
            update: function(event) {
                eval(event.body);
            }
        }
    });
</script>

##Documentation

The latest code documentation is available here.

##Build

The code documentation and the minified JavaScript build can be created using make.

make doc
make build

The build script requires YUI Compressor and YUI Doc which have to be configured in the makefile.