Skip to content

Commit c084dc5

Browse files
committed
add migration guide for upcoming release
1 parent aa8804b commit c084dc5

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
- [Installation](#installation)
2626
- [Example](#example)
2727
- [Compatibility with RxDB](#compatibility-with-rxdb)
28+
- [Migration Guide](#migration-guide)
2829
- [API](#api)
2930
- [`Provider`](#provider)
3031
- [`useRxDB`](#userxdb)
@@ -174,6 +175,12 @@ Please use the appropriate version of rxdb-hooks as per this table:
174175

175176
_\* Versions 7.x of RxDB and below have not been tested and are not guaranteed to work with rxdb-hooks_
176177

178+
## Migration Guide
179+
180+
- `4.x` => `5.x`
181+
- `useRxDocument` has been dropped; for fetching single documents simply use `useRxQuery` or `useRxData`
182+
- observing lazily created collection has become an opt-in feature that, if needed, has to be explicitly enabled by using the provided plugin. For more info see [Lazy instantiation of RxDatabase & RxCollections](#lazy-instantiation-of-rxdatabase--rxcollections)
183+
177184
## API
178185

179186
### `Provider`

0 commit comments

Comments
 (0)