<!--
    This Source Code Form is subject to the terms of the Mozilla Public
    License, v. 2.0. If a copy of the MPL was not distributed with this
    file, You can obtain one at http://mozilla.org/MPL/2.0/.
-->

<!--
    Copyright (c) 2016, Joyent, Inc.
-->

# node-moray

This repository is part of the Joyent Triton and Joyent Manta projects. See the
[Triton](https://github.com/joyent/triton/blob/master/CONTRIBUTING.md) and
[Manta](https://github.com/joyent/manta/blob/master/CONTRIBUTING.md)
contributing guidelines and general documentation at the main
[Triton](https://github.com/joyent/triton) and
[Manta](http://github.com/joyent/manta) project pages.


# Active Branches

1. The "master" branch is currently for node-moray 4.x releases.
2. The "3.x" branch is currently for node-moray 3.x releases to support users
   that must still use the older node-fast protocol (before node-fast 3.x).


# Overview

This is the Node.js client SDK for [Moray](https://github.com/joyent/moray).
You can install it with:

    npm install moray

or, to put the manual pages and CLI tools on your path:

    npm install -g moray

For usage information, see:

* [moray(1)](./docs/man/man1/moray.md) (overview manual page for CLI tools)
* [moray(3)](./docs/man/man3/moray.md) (overview manual page for library
  interface)
* [Moray server](https://github.com/joyent/moray) overview and reference
  documentation

# Testing

To test the Moray client, see the separate
[moray-test-suite](https://github.com/joyent/moray-test-suite) repository.