Skip to content

Commit cea2816

Browse files
committed
docs: add information about proper rn version
1 parent 7af2b60 commit cea2816

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

+15
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ A React Native at-least-once priority job queue / task queue backed by persisten
1313
## Table of Contents
1414

1515
* [Features](#features)
16+
* [React Native Compatibility](#react-native-compatibility)
1617
* [Example Use Cases](#example-use-cases)
1718
* [Installation](#installation)
1819
* [Basic Usage](#basic-usage)
@@ -32,6 +33,20 @@ A React Native at-least-once priority job queue / task queue backed by persisten
3233
* **Persistent Jobs:** Jobs are persisted with Realm. Because jobs persist, you can easily continue to process jobs across app restarts or in OS background tasks until completed or failed (or app is uninstalled).
3334
* **Powerful Integrations:** React Native Queue was designed to play well with others. The queue quickly integrates with a variety of OS background task and Worker packages so processing your jobs in a background service or dedicated thread have never been easier.
3435

36+
## React Native Compatibility
37+
38+
At the core this package leverages [Realm](https://github.com/realm/realm-js/blob/main/COMPATIBILITY.md) which maintains its own compatibility. This produces
39+
an interesting problem as we depend on a package which enforces React Native compatibility, but peer to react native.
40+
41+
This means it's very crucial to respect to select the proper version and respect the peering.
42+
43+
| Queue Version | Realm Version | React Native | Hermes Support |
44+
|---------------|---------------|--------------|----------------|
45+
| 2.2.0 | 11.10.1 | => 0.71.4 | Yes |
46+
| 2.1.1 | 11.5.2 | => 0.71.4 | Yes |
47+
| 2.1.0 | 11.5.1 | => 0.71.0 | Yes |
48+
| 2.0.0 | 10.21.1 | => 0.64.0 | No |
49+
3550
## Example Use Cases
3651

3752
**React Native Queue is designed to be a swiss army knife for task management in React Native**. It abstracts away the many annoyances related to processing complex tasks, like durability, retry-on-failure, timeouts, chaining processes, and more. **Just throw your jobs onto the queue and relax - they're covered**.

0 commit comments

Comments
 (0)