Natural Pleistocene Monsters

    @signalwire/realtime-api
    TypeScript icon, indicating that this package has built-in type declarations

    3.0.0 • Public • Published

    @signalwire/realtime-api

    SignalWire RealTime SDK

    Build Status NPM

    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 SignalWire RealTime SDK Documentation site.


    Contributing

    SignalWire RealTime SDK is open source and maintained by the SignalWire team, but we are very grateful for everyone who has contributed and assisted so far.

    If you'd like to contribute, feel free to visit our Slack channel 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 monorepo. To setup the dev environment follow these steps:

    1. Download the installer for the LTS version of RealTime. This is the best way to also install npm.
    2. Fork the 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.

    License

    @signalwire/realtime-api is copyright © 2018-2022 SignalWire. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.

    Install

    npm i @signalwire/realtime-api

    DownloadsWeekly Downloads

    100

    Version

    3.0.0

    License

    MIT

    Unpacked Size

    1.69 MB

    Total Files

    499

    Last publish

    Collaborators

    • bryanrite
    • danieleds
    • startledmarmot
    • egallo