Skip to content

Commit

Permalink
add migration guide for upcoming release
Browse files Browse the repository at this point in the history
  • Loading branch information
cvara committed Feb 24, 2023
1 parent aa8804b commit c084dc5
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
- [Installation](#installation)
- [Example](#example)
- [Compatibility with RxDB](#compatibility-with-rxdb)
- [Migration Guide](#migration-guide)
- [API](#api)
- [`Provider`](#provider)
- [`useRxDB`](#userxdb)
Expand Down Expand Up @@ -174,6 +175,12 @@ Please use the appropriate version of rxdb-hooks as per this table:

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

## Migration Guide

- `4.x` => `5.x`
- `useRxDocument` has been dropped; for fetching single documents simply use `useRxQuery` or `useRxData`
- 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)

## API

### `Provider`
Expand Down

0 comments on commit c084dc5

Please sign in to comment.