Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update setup and caveat info #228

Merged
merged 2 commits into from
Jul 3, 2023
Merged

docs: update setup and caveat info #228

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0ab244e
docs: update setup and caveat info
GregoryConrad Jul 3, 2023
11ea1cf
Merge branch 'main' into doc-updates
GregoryConrad Jul 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ A batteries-included NoSQL database for Dart & Flutter based on an embedded
- With Flutter, run `flutter pub add mimir flutter_mimir`
- For Dart-only, run `dart pub add mimir`

For macOS, [disable "App Sandbox"](https://stackoverflow.com/a/59752583/10003008).
Also read the [caveats below](#important-caveats).

## Demo
Expand Down Expand Up @@ -236,6 +237,7 @@ Please read these caveats _before_ adding mimir to your project.
- If you have multiple fields ending in `id`, use `instance.openIndex('indexName', primaryKey: 'theActualId')`
- The contents of the PK field can be a number, or a string matching the regex `^[a-zA-Z0-9-_]*$`
- In English: PKs can be alphanumeric and contain `-` and `_`
- Unfortunately, you can only open *1* index on iOS devices at the moment; see [here for more details and a workaround](https://github.com/GregoryConrad/mimir/issues/227).
- macOS App Sandbox is *not supported* at the moment, meaning you will not be able to submit apps to the *Mac* App Store
- You will still be able to distribute macOS applications on your own
- See more details [here](https://github.com/GregoryConrad/mimir/issues/101)
Expand All @@ -248,3 +250,5 @@ Please read these caveats _before_ adding mimir to your project.
- Note: while Isar does have full-text search, it is *neither typo-tolerant nor relevant*!
- If you need easy, typo-tolerant, relevant full-text search, you will want mimir!
- I am unaware of any other databases that currently provide typo-tolerant full-text search in Flutter, which is why I made mimir in the first place!
- Mimir can add a couple hundred MB to your app bundle size and <100 MB to the on-device size
- These numbers will hopefully be reduced in the future once Dart gets ["Native Assets"](https://github.com/dart-lang/sdk/issues/50565)