Skip to content

Commit b41f16a

Browse files
committed
Merge branch 'readme-update' into 'dev'
Improve README See merge request objectbox/objectbox-java!115
2 parents a40662c + e47c3c3 commit b41f16a

File tree

1 file changed

+44
-32
lines changed

1 file changed

+44
-32
lines changed

README.md

Lines changed: 44 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,25 @@
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.\
26+
Embedded into your Android, Linux, macOS, iOS, or Windows app, store and manage data easily, enjoy ludicrous speed, build ecoconciously 💚
1527

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-
```
28+
### Demo code
2929

3030
```java
3131
// Java
@@ -34,45 +34,57 @@ playlist.songs.add(new Song("Lalala"));
3434
playlist.songs.add(new Song("Lololo"));
3535
box.put(playlist);
3636
```
37+
--> [More details in the docs](https://docs.objectbox.io/)
3738

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

4047
## Table of Contents
4148
- [Why use ObjectBox](#why-use-objectbox)
4249
- [Features](#features)
43-
- [Gradle setup](#gradle-setup)
44-
- [First steps](#first-steps)
50+
- [How to get started](#how-to-get-started)
51+
- [Gradle setup](#gradle-setup)
52+
- [First steps](#first-steps)
4553
- [Already using ObjectBox?](#already-using-objectbox)
4654
- [Other languages/bindings](#other-languagesbindings)
4755
- [License](#license)
4856

49-
---
5057

51-
## Why use ObjectBox
58+
## Why use ObjectBox for Java data management / Kotlin data management?
59+
60+
The NoSQL Java database is built for storing data locally, offline-first on resource-restricted devices like phones.
61+
62+
The database is otimized 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.
5263

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).
64+
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).
5465

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.
66+
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 isgreat for handling large data volumes and allows changing your model whenever needed.
67+
68+
All of this makes ObjectBox a sustainable choice for local data persistence with Java and Kotlin - it's easy, efficient, and sustainable.
5669

5770
### Features
5871

5972
🏁 **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
73+
💚 **Resourceful** with minimal CPU, power and Memory usage for maximum flexibility and sustainability\
74+
🔗 **[Relations](https://docs.objectbox.io/relations):** object links / relationships are built-in\
75+
💻 **Multiplatform:** Linux, Windows, Android, iOS, macOS, any POSIX system
6376

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

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

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

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

@@ -100,7 +112,7 @@ plugins {
100112
apply plugin: "io.objectbox" // Add after other plugins.
101113
```
102114

103-
## First steps
115+
### First steps
104116

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

131143
## Already using ObjectBox?
132144

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

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

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

0 commit comments

Comments
 (0)