Skip to content

Commit 40a1f0b

Browse files
READMEs: resolve lint issues
1 parent 3113751 commit 40a1f0b

File tree

5 files changed

+32
-24
lines changed

5 files changed

+32
-24
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,6 @@
2525

2626
# Flutter database with vector support - easy to use & fast Dart object persistence, plus on-device vector search 💙
2727

28-
29-
3028
Very first on-device vector database for Flutter / Dart AI apps. Intuitive APIs, simply fast.
3129
Persist local Dart objects with ease & speed, efficiently manage vectors.
3230

@@ -63,6 +61,7 @@ final query = box // Query
6361
final List<Person> people = query.find();
6462
query.close();
6563
```
64+
6665
Ready? Continue with the ➡️ **[Getting Started guide](https://docs.objectbox.io/getting-started)**.
6766

6867
## Why use ObjectBox
@@ -78,6 +77,7 @@ Plus: We built a data synchronization solution that allows you to keep data in s
7877
and servers, both online and offline.
7978

8079
### Features
80+
8181
🏁 **Very first [on-device vector database](https://docs.objectbox.io/on-device-ann-vector-search)** - for AI apps that work any place.\
8282

8383
🏁 **High performance** - superfast response rates enabling real-time applications.\
@@ -95,7 +95,6 @@ Oh, and there is one more thing...
9595

9696
😮 [**Data Sync**](https://objectbox.io/sync/) - keeps data in sync offline or online, between devices and servers.
9797

98-
9998
## Getting Started
10099

101100
Continue with our ➡️ **[Getting Started guide](https://docs.objectbox.io/getting-started)**. It has resources and video tutorials on how to use ObjectBox in your Flutter or Dart app.
@@ -110,7 +109,7 @@ Continue with our ➡️ **[Getting Started guide](https://docs.objectbox.io/get
110109

111110
We tested across the four main database operations, CRUD (create, read, update, delete). Each test was run multiple times and executed manually outside of the measured time. Data preparation and evaluation were done outside of the measured time.
112111

113-
Here are the benchmarks for ObjectBox vs sqflite vs Hive 👇
112+
Here are the benchmarks for ObjectBox vs sqflite vs Hive (last updated 2021-09-11) 👇
114113

115114
![](https://raw.githubusercontent.com/objectbox/objectbox-dart/main/.github/benchmarks.png)
116115

@@ -135,19 +134,21 @@ For general news on ObjectBox, [check our blog](https://objectbox.io/blog)!
135134
Do you want to check out the ObjectBox code itself? E.g. see in action, run tests, or even contribute code?
136135
Great! Clone/check out this repository and run this to generate code and get you started quickly:
137136

138-
./tool/init.sh
137+
```bash
138+
./tool/init.sh
139+
```
139140

140141
Also, make sure to have a look at the [contribution guidelines](CONTRIBUTING.md) - we are looking forward to your contribution.
141142

142143
## Packages
143144

144145
This repository holds all ObjectBox Dart/Flutter packages as separate directories:
145146

146-
* [objectbox](objectbox) - main library code
147-
* [objectbox_generator](generator) - code generator
148-
* [objectbox_flutter_libs](flutter_libs) - core binary library dependency for Flutter (Android/iOS) - no dart/flutter code
149-
* [objectbox_sync_flutter_libs](sync_flutter_libs) - core binary library dependency with [**ObjectBox Sync**](https://objectbox.io/sync/) enabled
150-
* [benchmark](benchmark) - used internally to microbenchmark and compare various implementations during development of objectbox-dart
147+
- [objectbox](objectbox) - main library code
148+
- [objectbox_generator](generator) - code generator
149+
- [objectbox_flutter_libs](flutter_libs) - core binary library dependency for Flutter (Android/iOS) - no dart/flutter code
150+
- [objectbox_sync_flutter_libs](sync_flutter_libs) - core binary library dependency with [**ObjectBox Sync**](https://objectbox.io/sync/) enabled
151+
- [benchmark](benchmark) - used internally to microbenchmark and compare various implementations during development of objectbox-dart
151152

152153
There's also a separate repository benchmarking objectbox (and other databases) in Flutter:
153154
[objectbox-dart-performance](https://github.com/objectbox/objectbox-dart-performance). And another one testing and
@@ -157,11 +158,10 @@ comparing the performance of our FlatBuffers fork vs the upstream version: [flat
157158

158159
ObjectBox supports multiple platforms and languages:
159160

160-
* [Java Database](https://github.com/objectbox/objectbox-java) (+ Kotlin): runs on Android, desktop, and servers.
161-
* [Swift Database](https://github.com/objectbox/objectbox-swift): build fast mobile apps for iOS and macOS.
162-
* [Go Database](https://github.com/objectbox/objectbox-go): great for data-driven tools and embedded server applications.
163-
* [C / C++ Database](https://github.com/objectbox/objectbox-c): native speed with zero copy access to FlatBuffer objects.
164-
161+
- [Java Database](https://github.com/objectbox/objectbox-java) (+ Kotlin): runs on Android, desktop, and servers.
162+
- [Swift Database](https://github.com/objectbox/objectbox-swift): build fast mobile apps for iOS and macOS.
163+
- [Go Database](https://github.com/objectbox/objectbox-go): great for data-driven tools and embedded server applications.
164+
- [C / C++ Database](https://github.com/objectbox/objectbox-c): native speed with zero copy access to FlatBuffer objects.
165165

166166
## License
167167

benchmark/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,11 @@ Also see the full-application benchmark in https://github.com/objectbox/objectbo
1111
which provides a better picture of the potential "real world" performance.
1212

1313
## Compile for production
14+
1415
To get the most optimized version, build executables instead of running on Dart VM, for example:
1516

16-
`dart compile exe bin/basics.dart`
17+
```bash
18+
dart compile exe bin/basics.dart
19+
```
1720

1821
See https://dart.dev/tools/dart-compile for more options.

objectbox/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ Oh, and there is one more thing...
4949
😮 [**Data Sync**](https://objectbox.io/sync/) - sync only when and where needed.
5050

5151
## On this page
52+
5253
- [Sneak peek](#sneak-peek---persist-dart-objects-with-objectbox)
5354
- [Getting Started](#getting-started)
5455
- [Flutter Database Performance Benchmarks](#flutter-database-performance-benchmarks)
@@ -102,6 +103,7 @@ Read the ➡️ **[Getting Started guide](https://docs.objectbox.io/getting-star
102103
It has resources and video tutorials on how to use ObjectBox in your Flutter or Dart app.
103104

104105
We also have some video tutorials, each featuring a different example app:
106+
105107
- [Shop order app](https://youtu.be/AxYbdriXKI8)
106108
- [Restaurant: chef and order apps](https://youtu.be/r9Lc2r22KBk)
107109
- [Task-list app (in Spanish)](https://youtu.be/osUq6B92-BY)
@@ -111,7 +113,7 @@ We also have some video tutorials, each featuring a different example app:
111113

112114
We tested across the four main database operations, CRUD (create, read, update, delete). Each test was run multiple times and executed manually outside of the measured time. Data preparation and evaluation were also done outside of the measured time.
113115

114-
Here are the benchmarks for ObjectBox vs sqflite vs Hive 👇
116+
Here are the benchmarks for ObjectBox vs sqflite vs Hive (last updated 2021-09-11) 👇
115117

116118
![](https://raw.githubusercontent.com/objectbox/objectbox-dart/main/.github/benchmarks.png)
117119

@@ -140,8 +142,8 @@ See the [FAQ](https://docs.objectbox.io/faq) and [Troubleshooting](https://docs.
140142

141143
## See also
142144

143-
* [Changelog](CHANGELOG.md)
144-
* [Contribution guidelines](../CONTRIBUTING.md)
145+
- [Changelog](CHANGELOG.md)
146+
- [Contribution guidelines](../CONTRIBUTING.md)
145147

146148
## License
147149

objectbox_test/README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,29 @@ Contains unit tests for the [`objectbox`](../objectbox) package to avoid a cycli
44
[`objectbox_generator`](../generator).
55

66
To run set up the package:
7-
```
7+
8+
```bash
89
dart pub get
910
dart run build_runner build
1011
```
1112

1213
And run the tests:
13-
```
14+
15+
```bash
1416
dart test
1517
```
1618

1719
Or for better log output (e.g. to attribute native logs to a test):
18-
```
20+
21+
```bash
1922
# Run only one test suite (== test file) at a time.
2023
# Print log for every completed test.
2124
dart test --concurrency=1 --reporter expanded
2225
```
2326

2427
To run tests using an in-memory database:
25-
```
28+
29+
```bash
2630
export OBX_IN_MEMORY=true
2731
dart test
2832
```

sync_flutter_libs/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,3 @@ client included, as a Flutter plugin for supported platforms.
77
You should add this package as a dependency when using [ObjectBox](https://pub.dev/packages/objectbox) with Flutter.
88

99
See package [objectbox](https://pub.dev/packages/objectbox) for more details and information how to use it.
10-

0 commit comments

Comments
 (0)