Copy dist/browser-matrix-$VERSION.js and add that as a <script> to your page. There will be a global variable matrixcs attached to window through which you can access the SDK.

Please check examples/browser for a working example.

In Node.js

npm install matrix-js-sdk

var sdk = require("matrix-js-sdk");
var client = sdk.createClient("https://matrix.org");
client.publicRooms(function(err, data) {
  console.log("Public Rooms: %s", JSON.stringify(data));
});

Please check examples/node to see a working version.

Contributing

This section is for people who want to modify the SDK. If you just want to use this SDK, skip this section.

First, you need to pull in the right build tools:

$ npm install

Building

To build a browser version from scratch when developing:

$ npm run build

To constantly do builds when files are modified (using watchify):

$ npm run watch

To run tests (Jasmine):

$ npm test

To run linters (Google Closure Linter and JSHint):

$ npm run lint