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:

import * as Ably from 'ably'
const realtime = new Ably.Realtime(<options or api key>)

// Or if using a toolchain that doesn't support ES6 module syntax:
const Ably = require('ably');
const client = new Ably.Realtime(<options or api key>);

For the REST-only library:

import * as Ably from 'ably'
const realtime = new Ably.Rest(<options or api key>)

// Or if using a toolchain that doesn't support ES6 module syntax:
const Ably = require('ably');
const client = new Ably.Rest(<options or api key>);

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

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

(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 (in this repo only for issues specific to react-native or this wrapper; all other issues should go in the main ably-js repo) or contact us

Release process

This library uses semantic versioning. For each release, the following needs to be done:

• Update the version number by running npm version <type> (see docs) and commit the change.
• Add a tag and push to origin such as git tag v1.0.0 && git push origin v1.0.0
• Run npm publish to publish the gem to npm

License

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