Skip to content

Commit 815ee06

Browse files
committed
Update README
1 parent a40662c commit 815ee06

File tree

1 file changed

+38
-31
lines changed

1 file changed

+38
-31
lines changed

README.md

Lines changed: 38 additions & 31 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

11-
# ObjectBox Java Database (Kotlin, Android)
12-
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.
15-
16-
**Latest version: `3.3.1` (2022/09/05, [Release Notes](https://docs.objectbox.io/#objectbox-changelog))**
23+
# Java Database (+ Kotlin, Android) for sustainable local data storage
1724

18-
**Your opinion matters to us!** Please fill in this 2-minute [Anonymous Feedback Form](https://forms.gle/bdktGBUmL4m48ruj7).
25+
Database for Java that's embedded into your Android, Linux, macOS, or Windows app. Store and manage data efficiently and effortlessly.
1926

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
@@ -35,44 +34,52 @@ playlist.songs.add(new Song("Lololo"));
3534
box.put(playlist);
3635
```
3736

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

4046
## Table of Contents
4147
- [Why use ObjectBox](#why-use-objectbox)
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?
58+
59+
This 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).
5260

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).
61+
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. It's also build for handling large data volumes and allows changing your model whenever needed.
5462

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.
63+
All of this makes ObjectBox a sustainable choice for Java data persistence - it's efficient, green, and scalable.
5664

5765
### Features
5866

5967
🏁 **High performance** on restricted devices, like IoT gateways, micro controllers, ECUs etc.\
6068
🪂 **Resourceful** with minimal CPU, power and Memory usage for maximum flexibility and sustainability\
61-
🔗 **Relations:** object links / relationships are built-in\
69+
🔗 **[Relations](https://docs.objectbox.io/relations):** object links / relationships are built-in\
6270
💻 **Multiplatform:** Linux, Windows, Android, iOS, macOS
6371

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

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

73-
Enjoy ❤️
74-
75-
## Gradle setup
81+
## How to get started
82+
### Gradle setup
7683

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

@@ -100,7 +107,7 @@ plugins {
100107
apply plugin: "io.objectbox" // Add after other plugins.
101108
```
102109

103-
## First steps
110+
### First steps
104111

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

131138
## Already using ObjectBox?
132139

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.
140+
**Your opinion matters to us!** Please fill in this 2-minute [Anonymous Feedback Form](https://forms.gle/bdktGBUmL4m48ruj7).
134141

135-
To do that, we want your feedback: what do you love? What's amiss? Where do you struggle in everyday app development?
142+
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. To do that, we want your feedback: what do you love? What's amiss? Where do you struggle in everyday app development?
136143

137144
**We're looking forward to receiving your comments and requests:**
138145
- Add [GitHub issues](https://github.com/ObjectBox/objectbox-java/issues)

0 commit comments

Comments
 (0)