@signalwire/realtime-api

Version:

SignalWire RealTime SDK for Node.js

github.com/signalwire/signalwire-js/tree/master/packages/realtime-api

39 lines (22 loc) • 2.31 kB

Markdown

# @signalwire/realtime-api # RELAY RealTime SDK [![The build status of the package @signalwire/realtime-api.](https://ci.signalwire.com/api/badges/signalwire/signalwire-js/status.svg)](https://ci.signalwire.com/signalwire/signalwire-js) ![The NPM shield for the package @signalwire/realtime-api.](https://img.shields.io/npm/v/@signalwire/realtime-api.svg?color=brightgreen) The RealTime SDK enables Node.js developers to connect and use SignalWire's RealTime APIs within their own Node.js code. Our RealTime SDK allows developers to build or add robust and innovative communication services to their applications. ## Getting Started Read the implementation documentation, guides and API Reference at the official [RELAY RealTime SDK Documentation](https://developer.signalwire.com/sdks/reference/realtime-sdk) site. --- ## Contributing SignalWire RealTime SDK is open source and maintained by the SignalWire team, but we are very grateful for [everyone](https://github.com/signalwire/signalwire-js/contributors) who has contributed and assisted so far. If you'd like to contribute, feel free to visit our [Slack channel](https://signalwire.community/) and read our developer section to get the code running in your local environment. ## Developers The RealTime SDK is a package inside the [signalwire-js](https://github.com/signalwire/signalwire-js) _monorepo_. To setup the dev environment follow these steps: 1. [Download the installer](https://nodejs.org/) for the LTS version of RealTime. This is the best way to also [install npm](https://blog.npmjs.org/post/85484771375/how-to-install-npm#_=_). 2. Fork the [signalwire-js](https://github.com/signalwire/signalwire-js) repository and clone it. 3. Create a new branch from `main` for your change. 4. Run `npm install` to install global dependencies. 5. Navigate into the `realtime-api` directory with `cd packages/realtime-api`. 6. Make changes! ## Versioning SignalWire RealTime SDK follows Semantic Versioning 2.0 as defined at [http://semver.org](http://semver.org). ## License `@signalwire/realtime-api` is copyright © 2018-2023 [SignalWire](http://signalwire.com). It is free software, and may be redistributed under the terms specified in the [MIT-LICENSE](https://github.com/signalwire/signalwire-js/blob/master/LICENSE) file.