Skip to content

Commit 8f7a416

Browse files
Update README.md
1 parent b2a84f9 commit 8f7a416

File tree

1 file changed

+48
-37
lines changed

1 file changed

+48
-37
lines changed

README.md

Lines changed: 48 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,24 @@
77
<a href="https://github.com/objectbox/objectbox-java/issues">Issues</a>
88
</p>
99

10+
<p align="center">
11+
<a href="https://docs.objectbox.io/#objectbox-changelog">
12+
<img src="https://img.shields.io/github/v/release/objectbox/objectbox-java?color=7DDC7D&style=flat-square" alt="Latest Release">
13+
</a>
14+
<img src="https://img.shields.io/github/stars/objectbox/objectbox-java?color=17A6A6&logo=github&style=flat-square" alt="Star objectbox-java">
15+
<a href="https://github.com/objectbox/objectbox-java/blob/main/LICENSE.txt">
16+
<img src="https://img.shields.io/github/license/objectbox/objectbox-java?color=7DDC7D&logo=apache&style=flat-square" alt="Apache 2.0 license">
17+
</a>
18+
<a href="https://twitter.com/ObjectBox_io">
19+
<img src="https://img.shields.io/twitter/follow/objectbox_io?color=%20%2300aced&logo=twitter&style=flat-square" alt="Follow @ObjectBox_io">
20+
</a>
21+
</p>
1022

1123
# ObjectBox Java Database (Kotlin, Android)
1224

13-
[ObjectBox](https://objectbox.io/) is a superfast object-oriented Java database with strong relation support and easy-to-use native language APIs.
14-
ObjectBox is embedded into your Android, Linux, macOS, or Windows app.
25+
Java database - simple but powerful, frugal but fast. Embedded into your Android, Linux, macOS, iOS, or Windows app, store and manage data easily, enjoy ludicrous speed, build ecoconciously 💚
1526

16-
**Latest version: `3.3.1` (2022/09/05, [Release Notes](https://docs.objectbox.io/#objectbox-changelog))**
17-
18-
**Your opinion matters to us!** Please fill in this 2-minute [Anonymous Feedback Form](https://forms.gle/bdktGBUmL4m48ruj7).
19-
20-
Demo code using ObjectBox:
21-
22-
```kotlin
23-
// Kotlin
24-
val playlist = Playlist("My Favorites")
25-
playlist.songs.add(Song("Lalala"))
26-
playlist.songs.add(Song("Lololo"))
27-
box.put(playlist)
28-
```
27+
### Demo code
2928

3029
```java
3130
// Java
@@ -34,45 +33,57 @@ playlist.songs.add(new Song("Lalala"));
3433
playlist.songs.add(new Song("Lololo"));
3534
box.put(playlist);
3635
```
36+
--> [More details in the docs](https://docs.objectbox.io/)
3737

38-
🧾 **Want details?** [Read the docs](https://docs.objectbox.io/)
38+
```kotlin
39+
// Kotlin
40+
val playlist = Playlist("My Favorites")
41+
playlist.songs.add(Song("Lalala"))
42+
playlist.songs.add(Song("Lololo"))
43+
box.put(playlist)
44+
```
3945

4046
## Table of Contents
41-
- [Why use ObjectBox](#why-use-objectbox)
47+
- [Why use ObjectBox](#why-use-objectbox-for-java-data-management--kotlin-data-management)
4248
- [Features](#features)
43-
- [Gradle setup](#gradle-setup)
44-
- [First steps](#first-steps)
49+
- [How to get started](#how-to-get-started)
50+
- [Gradle setup](#gradle-setup)
51+
- [First steps](#first-steps)
4552
- [Already using ObjectBox?](#already-using-objectbox)
4653
- [Other languages/bindings](#other-languagesbindings)
4754
- [License](#license)
4855

49-
---
5056

51-
## Why use ObjectBox
57+
## Why use ObjectBox for Java data management / Kotlin data management?
58+
59+
The NoSQL Java database is built for storing data locally, offline-first on resource-restricted devices like phones.
60+
61+
The database is optimized for high speed and low resource consumption on restricted devices, making it ideal for use on mobile devices. It uses minimal CPU, RAM, and power, which is not only great for users but also for the environment.
5262

53-
ObjectBox NoSQL Java database is built for storing data locally on mobile devices. It is optimized for high efficiency on restricted devices and uses minimal CPU and RAM. Being fully ACID-compliant, ObjectBox is faster than any alternative, outperforming SQLite and Realm across all CRUD (Create, Read, Update, Delete) operations. Check out our [Performance Benchmarking App repository](https://github.com/objectbox/objectbox-performance).
63+
Being fully ACID-compliant, ObjectBox is faster than any alternative, outperforming SQLite and Realm across all CRUD (Create, Read, Update, Delete) operations. Check out our [Performance Benchmarking App repository](https://github.com/objectbox/objectbox-performance).
5464

55-
Additionally, our concise API is easy to learn and only requires a fraction of the code compared to SQLite. No more rows or columns, just plain objects with built-in relations.
65+
Our concise native-language API is easy to pick up and only requires a fraction of the code compared to SQLite. No more rows or columns, just plain objects (true POJOS) with built-in relations. It's great for handling large data volumes and allows changing your model whenever needed.
66+
67+
All of this makes ObjectBox a smart choice for local data persistence with Java and Kotlin - it's efficient, easy and sustainable.
5668

5769
### Features
5870

5971
🏁 **High performance** on restricted devices, like IoT gateways, micro controllers, ECUs etc.\
60-
🪂 **Resourceful** with minimal CPU, power and Memory usage for maximum flexibility and sustainability\
61-
🔗 **Relations:** object links / relationships are built-in\
62-
💻 **Multiplatform:** Linux, Windows, Android, iOS, macOS
72+
💚 **Resourceful** with minimal CPU, power and Memory usage for maximum flexibility and sustainability\
73+
🔗 **[Relations](https://docs.objectbox.io/relations):** object links / relationships are built-in\
74+
💻 **Multiplatform:** Linux, Windows, Android, iOS, macOS, any POSIX system
6375

6476
🌱 **Scalable:** handling millions of objects resource-efficiently with ease\
65-
💐 **Queries:** filter data as needed, even across relations\
77+
💐 **[Queries](https://docs.objectbox.io/queries):** filter data as needed, even across relations\
6678
🦮 **Statically typed:** compile time checks & optimizations\
6779
📃 **Automatic schema migrations:** no update scripts needed
6880

6981
**And much more than just data persistence**\
7082
🔄 **[ObjectBox Sync](https://objectbox.io/sync/):** keeps data in sync between devices and servers\
7183
🕒 **[ObjectBox TS](https://objectbox.io/time-series-database/):** time series extension for time based data
7284

73-
Enjoy ❤️
74-
75-
## Gradle setup
85+
## How to get started
86+
### Gradle setup
7687

7788
For Android projects, add the ObjectBox Gradle plugin to your root `build.gradle`:
7889

@@ -100,7 +111,7 @@ plugins {
100111
apply plugin: "io.objectbox" // Add after other plugins.
101112
```
102113

103-
## First steps
114+
### First steps
104115

105116
Create a data object class `@Entity`, for example "Playlist".
106117
```
@@ -130,9 +141,9 @@ For details please check the [docs](https://docs.objectbox.io).
130141

131142
## Already using ObjectBox?
132143

133-
We believe, ObjectBox is super easy to use. We are on a mission to make developers’ lives better, by building developer tools that are intuitive and fun to code with.
144+
**Your opinion matters to us!** Please fill in this 2-minute [Anonymous Feedback Form](https://forms.gle/bdktGBUmL4m48ruj7).
134145

135-
To do that, we want your feedback: what do you love? What's amiss? Where do you struggle in everyday app development?
146+
We believe, ObjectBox is super easy to use. We want to bring joy and delight to app developers with intuitive and fun to code with APIs. To do that, we want your feedback: what do you love? What's amiss? Where do you struggle in everyday app development?
136147

137148
**We're looking forward to receiving your comments and requests:**
138149
- Add [GitHub issues](https://github.com/ObjectBox/objectbox-java/issues)
@@ -149,10 +160,10 @@ Keep in touch: For general news on ObjectBox, [check our blog](https://objectbox
149160
ObjectBox supports multiple platforms and languages.
150161
Besides JVM based languages like Java and Kotlin, ObjectBox also offers:
151162

152-
* [ObjectBox Swift Database](https://github.com/objectbox/objectbox-swift): build fast mobile apps for iOS (and macOS)
153-
* [ObjectBox Dart/Flutter Database](https://github.com/objectbox/objectbox-dart): cross-platform for mobile and desktop apps
154-
* [ObjectBox Go Database](https://github.com/objectbox/objectbox-go): great for data-driven tools and embedded server applications
155-
* [ObjectBox C and C++ Database](https://github.com/objectbox/objectbox-c): native speed with zero copy access to FlatBuffer objects
163+
* [Swift Database](https://github.com/objectbox/objectbox-swift): build fast mobile apps for iOS (and macOS)
164+
* [Dart/Flutter Database](https://github.com/objectbox/objectbox-dart): cross-platform for mobile and desktop apps
165+
* [Go Database](https://github.com/objectbox/objectbox-go): great for data-driven tools and embedded server applications
166+
* [C and C++ Database](https://github.com/objectbox/objectbox-c): native speed with zero copy access to FlatBuffer objects
156167

157168

158169
## License

0 commit comments

Comments
 (0)