Skip to content

Commit 014d245

Browse files
authored
docs: advertise ferry_hive_ce_store als alternative to ferry_hive_store
1 parent da66376 commit 014d245

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

docs/setup.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,8 @@ final client = Client(link: link, cache: cache);
4040

4141
## Setup With HiveStore
4242

43-
Ferry includes a `HiveStore` which enables offline data persistance, based on the `hive` package.
43+
Ferry includes a `HiveStore` which enables offline data persistence, based on the `hive` package.
44+
4445

4546
### Install Dependencies
4647

@@ -58,6 +59,12 @@ dev_dependencies:
5859
build_runner: #[latest-version]
5960
```
6061

62+
Since `hive` seems to be unmaintained, and the community forked it via the `hive_ce` package, Ferry also includes a `ferry_hive_ce_store`
63+
with the same API.
64+
65+
Since the underlying file formats are binary compatible, switching from `ferry_hive_store ` to `ferry_hive_ce_store` is possible without any data migration.
66+
67+
6168
:::important
6269

6370
If you're using Flutter, you'll also need to add:

0 commit comments

Comments
 (0)