Skip to content

Commit 3b71204

Browse files
obx-viviengreenrobot-team
authored andcommitted
README: update, simplify some passages.
- move contributing section next to package info.
1 parent d971241 commit 3b71204

File tree

2 files changed

+19
-20
lines changed

2 files changed

+19
-20
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626

2727
# Flutter database for fast Dart object persistence 💙
2828

29-
ObjectBox Flutter database is a great option for storing data in your cross-platform apps. It uses minimal CPU, memory and battery, which makes it an ideal choice for mobile and IoT devices. It is made for efficient data access and is 10x faster than any alternative. See the [performance benchmarks](#flutter-database-performance-benchmarks) below. No need to learn SQL, as our NoSQL database uses pure Dart API that is easy to work with and can be integrated in minutes. Apart from that, we built a data synchronization solution that allows you to choose which objects to sync when and keep data easily and efficiently in sync across devices.
29+
ObjectBox Flutter database is a great option for storing Dart objects locally in your cross-platform apps. It uses minimal CPU, memory and battery, which makes it an ideal choice for mobile and IoT devices. Made for efficient data access, it is 10x faster than any alternative across all CRUD operations. See the [performance benchmarks](#flutter-database-performance-benchmarks) below. No need to learn SQL, as our NoSQL database uses a pure Dart API that is easy to work with and can be integrated in minutes. Plus: We built a data synchronization solution that allows you to choose which objects to sync when and keep data easily and efficiently in sync across devices.
3030

3131
### Features
3232

@@ -43,22 +43,13 @@ ObjectBox Flutter database is a great option for storing data in your cross-plat
4343
Oh, and there is one more thing...
4444
😮 [**Data Sync**](https://objectbox.io/sync/) - keeps data in sync offline or online, between devices and servers.
4545

46-
## Getting Started (in your App)
46+
## Getting Started
4747

4848
To start using ObjectBox in your Flutter/Dart app, head over to
4949

5050
* the [ObjectBox pub.dev page](https://pub.dev/packages/objectbox) or
5151
* check out our [Getting Started Guide](https://docs.objectbox.io/getting-started).
52-
* if you prefer to start with a video tutorial, [here you go](https://www.youtube.com/watch?v=BBlr8F8m9lo)
53-
54-
## Getting Started with this Repository
55-
56-
Do you want to check out the ObjectBox code itself? E.g. see in action, run tests, or even contribute code?
57-
Great! Clone/check out this repository and run this to generate code and get you started quickly:
58-
59-
./tool/init.sh
60-
61-
Also, make sure to have a look at the [contribution guidelines](CONTRIBUTING.md) - we are looking forward to your contribution.
52+
* if you prefer video, in this tutorial you'll [learn how to persist data locally in your Flutter App](https://www.youtube.com/watch?v=BBlr8F8m9lo)
6253

6354
## Flutter Database Performance Benchmarks
6455

@@ -89,6 +80,15 @@ Thank you! 🙏
8980

9081
Keep in touch: For general news on ObjectBox, [check our blog](https://objectbox.io/blog)!
9182

83+
## Contributing
84+
85+
Do you want to check out the ObjectBox code itself? E.g. see in action, run tests, or even contribute code?
86+
Great! Clone/check out this repository and run this to generate code and get you started quickly:
87+
88+
./tool/init.sh
89+
90+
Also, make sure to have a look at the [contribution guidelines](CONTRIBUTING.md) - we are looking forward to your contribution.
91+
9292
## Packages
9393

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

objectbox/README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,7 @@
2626

2727
# Flutter database for Dart-native objects 💙
2828

29-
🙌 **Your opinion matters to us!** Please fill in this 2-minute [Anonymous Feedback Form](https://forms.gle/LvVjN6jfFHuivxZX6).
30-
31-
ObjectBox Flutter database is a great option for storing data in your cross-platform apps. It uses minimal CPU, memory and battery, which makes it an ideal choice for mobile and IoT devices. It is made for efficient data access and is 10x faster than any alternative. See the [performance benchmarks](#flutter-database-performance-benchmarks) below. No need to learn SQL, as our NoSQL database uses pure Dart API that is easy to work with and can be integrated in minutes. Apart from that, we built a data synchronization solution that allows you to choose which objects to sync when and therefore keep your cloud costs low.
29+
ObjectBox Flutter database is a great option for storing Dart objects in your cross-platform apps. Minimal CPU, memory and battery use make it an ideal choice for mobile and IoT devices. Made for efficient data access, the ObjectBox Flutter database is 10x faster than any alternative. See the [performance benchmarks](#flutter-database-performance-benchmarks) below. No need to learn SQL, as our NoSQL database uses a pure Dart API that is easy to work with and can be integrated in minutes. Plus: We built a data synchronization solution that allows you to choose which objects to sync when and keep data easily and efficiently in sync across devices.
3230

3331
### Features
3432

@@ -82,10 +80,11 @@ final people = query.find(); // find() returns List<Person>
8280

8381
Check out our new [Getting Started guide](https://docs.objectbox.io/getting-started).
8482

85-
We also have three video tutorials, each featuring a different example app:
83+
We also have some video tutorials, each featuring a different example app:
8684
- [Shop order app](https://youtu.be/AxYbdriXKI8)
8785
- [Restaurant: chef and order apps](https://youtu.be/r9Lc2r22KBk)
8886
- [Task-list app (in Spanish)](https://youtu.be/osUq6B92-BY)
87+
- [Inventory Management](https://www.youtube.com/watch?v=BBlr8F8m9lo)
8988

9089

9190
**Depending on if you are building a Flutter or Dart-only app, follow the steps below to start using ObjectBox.**
@@ -172,16 +171,16 @@ You can run these yourself using our [objectbox-dart-performance](https://github
172171

173172
## Do you 💙 ObjectBox?
174173

175-
We strive to bring joy to Flutter developers and appreciate all kind of feedback, both positive and negative.
176-
What do you love? What's amiss? Where do you struggle in everyday app development?
174+
We strive to bring joy to Flutter developers and appreciate any feedback
175+
--> Please fill in this 2-minute [Anonymous Feedback Form](https://forms.gle/LvVjN6jfFHuivxZX6).
177176

178-
**We're looking forward to receiving your comments and requests:**
177+
**We ❤️ you & are looking forward to your comments and ideas:**
179178

180179
- Add [GitHub issues](https://github.com/objectbox/objectbox-dart/issues)
181180
- Upvote issues you find important by hitting the 👍/+1 reaction button
182181
- Fill in the [feedback form](https://forms.gle/s2L1YH32nwjgs4s4A) to help us improve our products
183182
- Drop us a line on Twitter via [@ObjectBox_io](https://twitter.com/ObjectBox_io/)
184-
- ⭐ us, if you like what you see
183+
- ⭐ us on GitHub, if you like what you see or give us a 👍 on [pub.dev](https://pub.dev/packages/objectbox)
185184

186185
Thank you! 🙏
187186

0 commit comments

Comments
 (0)