search

isar / isar

Extremely fast, easy to use, and fully async NoSQL database for Flutter
https://isar.dev
Apache License 2.0
3.64k stars 359 forks source link

docs: Readme in repository missing isar_generator #1606

Open ElectricCookie opened 7 months ago

ElectricCookie commented 7 months ago

Just a quick heads up 👋🏻, in the readme the dev dependency for isar_generator is missing.

https://github.com/isar/isar/blob/04886f692d6e1935e695ae993f77848b023dfb80/packages/isar/README.md?plain=1#L73C1-L75C4

On https://isar.dev/tutorials/quickstart.html#_1-add-dependencies it's complete

nobkd commented 7 months ago

That was in preparation for Isar v4: https://github.com/isar/isar/commit/41988e4fd6810c43d0a21fa9a6d3423b6f017916#diff-e69b3925547c4557b2e4a8db5f49880cd11e18f636d0997bd3c11ebaa0d1c72bL72-L74

For v4 that package is included in Isar, and won't have to be specified anymore.

For v3 it is still needed

Would recommend to check out the community fork, as the maintainer of this package is currently absent. The community fork mainly provides updated dependencies.

See some related to community fork: #1604, https://github.com/isar/isar/discussions/1590#discussioncomment-9022412, https://github.com/isar/isar/discussions/1587#discussioncomment-8932294