From d9dfa72abc8840acf721fa61a7c6fbeff459a07b Mon Sep 17 00:00:00 2001 From: radex Date: Sun, 15 Oct 2023 20:14:01 +0200 Subject: [PATCH] Update README to reflect deprecation/merger with WatermelonDB --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 8f32266..4a59b46 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,16 @@ A [higher-order component](https://reactjs.org/docs/higher-order-components.html) for connecting RxJS [Observables](https://github.com/ReactiveX/rxjs) to React components. +## ⚠️ Deprecation notice ⚠️ + +**`@nozbe/with-observables` as a standalone package is deprecated as of August 2023.** + +It continues to live on as part of [WatermelonDB](https://github.com/Nozbe/WatermelonDB). If you use WatermelonDB 0.27 or later, use this import instead: + +```js +`import { withObservables } from '@nozbe/watermelondb/react'` +``` + ## Example (Taken from [WatermelonDB](https://github.com/Nozbe/WatermelonDB/))