Skip to content

Commit 28257e7

Browse files
READMEs: update to clearly separate Dart APIs from database libraries
1 parent cd5fcfe commit 28257e7

File tree

3 files changed

+14
-14
lines changed

3 files changed

+14
-14
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -144,24 +144,24 @@ Also, make sure to have a look at the [contribution guidelines](CONTRIBUTING.md)
144144

145145
This repository holds all ObjectBox Dart/Flutter packages as separate directories:
146146

147-
- [objectbox](objectbox) - main library code
147+
- [objectbox](objectbox) - ObjectBox Dart APIs
148+
- [objectbox_test](objectbox_test) - unit tests of the ObjectBox Dart APIs
148149
- [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
150+
- [objectbox_flutter_libs](flutter_libs) - provides the native database libraries for Flutter apps
151+
- [objectbox_sync_flutter_libs](sync_flutter_libs) - provides the native database libraries with [**ObjectBox Sync**](https://objectbox.io/sync/) enabled
152+
- [benchmark](benchmark) - used internally to microbenchmark and compare various implementations during development
152153

153154
There's also a separate repository benchmarking objectbox (and other databases) in Flutter:
154-
[objectbox-dart-performance](https://github.com/objectbox/objectbox-dart-performance). And another one testing and
155-
comparing the performance of our FlatBuffers fork vs the upstream version: [flatbuffers-benchmark](https://github.com/objectbox/flatbuffers-benchmark).
155+
[objectbox-dart-performance](https://github.com/objectbox/objectbox-dart-performance).
156156

157157
## Other languages/bindings
158158

159159
ObjectBox supports multiple platforms and languages:
160160

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

166166
## License
167167

flutter_libs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# ObjectBox libraries for Flutter
1+
# ObjectBox database libraries for Flutter
22

33
[![pub package](https://img.shields.io/pub/v/objectbox_flutter_libs.svg)](https://pub.dev/packages/objectbox_flutter_libs)
44

5-
This package provides the native ObjectBox library as a Flutter plugin for supported platforms.
5+
This package provides the native ObjectBox database library as a Flutter plugin for supported platforms.
66
You should add this package as a dependency when using [ObjectBox](https://pub.dev/packages/objectbox) with Flutter.
77

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

sync_flutter_libs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# ObjectBox (with [Sync](https://objectbox.io/sync)) libraries for Flutter
1+
# ObjectBox database (with [Sync](https://objectbox.io/sync)) libraries for Flutter
22

33
[![pub package](https://img.shields.io/pub/v/objectbox_sync_flutter_libs.svg)](https://pub.dev/packages/objectbox_sync_flutter_libs)
44

5-
This package provides the native ObjectBox library, with the [Sync](https://objectbox.io/sync)
5+
This package provides the native ObjectBox database library, with the [Sync](https://objectbox.io/sync)
66
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

0 commit comments

Comments
 (0)