Skip to content

Commit 7b84acd

Browse files
database description in README
plus a couple of other small edits
1 parent 7471eb4 commit 7b84acd

File tree

1 file changed

+20
-6
lines changed

1 file changed

+20
-6
lines changed

README.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,21 @@
11
<p align="center"><img width="466" src="https://raw.githubusercontent.com/objectbox/objectbox-java/master/logo.png"></p>
22

3+
<p align="center">
4+
<a href="https://docs.objectbox.io/getting-started">Getting Started</a> •
5+
<a href="https://docs.objectbox.io">Documentation</a> •
6+
<a href="https://github.com/objectbox/objectbox-examples">Example Apps</a> •
7+
<a href="https://github.com/objectbox/objectbox-java/issues">Issues</a>
8+
</p>
9+
10+
311
# ObjectBox Java Database (Kotlin, Android)
412

5-
[ObjectBox](https://objectbox.io/) is a superfast object-oriented database with strong relation support and easy-to-use native language APIs.
13+
[ObjectBox](https://objectbox.io/) is a superfast object-oriented Java database with strong relation support and easy-to-use native language APIs.
614
ObjectBox is embedded into your Android, Linux, macOS, or Windows app.
715

816
**Latest version: [3.1.2 (2022/02/21)](https://docs.objectbox.io/#objectbox-changelog)**
917

10-
**Your opinion matters to us!** Please fill in this 2-minute [Anonymous Feedback Form](https://forms.gle/bdktGBUmL4m48ruj7).
18+
**Your opinion matters to us!** Please fill in this 2-minute [Anonymous Feedback Form](https://forms.gle/bdktGBUmL4m48ruj7).
1119

1220
Demo code using ObjectBox:
1321

@@ -27,9 +35,15 @@ playlist.songs.add(new Song("Lololo"));
2735
box.put(playlist);
2836
```
2937

30-
Want details? **[Read the docs](https://docs.objectbox.io/)**
38+
🧾 **Want details?** [Read the docs](https://docs.objectbox.io/)
39+
40+
## Why use ObjectBox
41+
42+
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).
3143

32-
## Features
44+
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.
45+
46+
### Features
3347

3448
🏁 **High performance** on restricted devices, like IoT gateways, micro controllers, ECUs etc.\
3549
🪂 **Resourceful** with minimal CPU, power and Memory usage for maximum flexibility and sustainability\
@@ -42,7 +56,7 @@ Want details? **[Read the docs](https://docs.objectbox.io/)**
4256
📃 **Automatic schema migrations:** no update scripts needed
4357

4458
**And much more than just data persistence**\
45-
👥 **[ObjectBox Sync](https://objectbox.io/sync/):** keeps data in sync between devices and servers\
59+
🔄 **[ObjectBox Sync](https://objectbox.io/sync/):** keeps data in sync between devices and servers\
4660
🕒 **[ObjectBox TS](https://objectbox.io/time-series-database/):** time series extension for time based data
4761

4862
Enjoy ❤️
@@ -106,6 +120,7 @@ For details please check the [docs](https://docs.objectbox.io).
106120
## Already using ObjectBox?
107121

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

111126
**We're looking forward to receiving your comments and requests:**
@@ -144,4 +159,3 @@ Besides JVM based languages like Java and Kotlin, ObjectBox also offers:
144159
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
145160
See the License for the specific language governing permissions and
146161
limitations under the License.
147-

0 commit comments

Comments
 (0)