ably-react-native

Ably

A React Native client library for Ably Realtime, a realtime data delivery platform.

This repo is a wrapper for the ably-js client library which introduces a dependency needed by React Native. See the ably-js README for usage details of the ably-js client library.

For complete API documentation, see the Ably Realtime documentation.

How to use this library

Installation from npm

npm install ably-react-native

Usage

For the realtime library:

var realtime = require('ably').Realtime;

For the rest-only library:

var realtime = require('ably').Rest;

For older versions of React Native, which do not support the react-native automatic entrypoint, you may have to instead do

var realtime = require('ably/browser/static/ably-reactnative.js').Realtime;

(and similarly for Rest)

API usage, tests, contributing, etc.

See the ably-js repo.

FAQs

Is this repo actively maintained?

Yes, this repo typically has very fwe recent commits because this React Native repo doesn't do very much: it's a very thin wrapper around the ably-js repo.

Does this repo support all platforms supported by React Native?

Yes, as far as we know. If you find any issues, please raise an issue or contact us

License

Copyright (c) 2016 Ably Real-time Ltd, Licensed under the Apache License, Version 2.0. Refer to LICENSE for the license terms.