Skip to content

Commit 1e4b573

Browse files
README: fix linter issues
1 parent f26d198 commit 1e4b573

File tree

1 file changed

+42
-33
lines changed

1 file changed

+42
-33
lines changed

README.md

Lines changed: 42 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<p align="center"><img width="466" src="https://raw.githubusercontent.com/objectbox/objectbox-java/master/logo.png"></p>
1+
<p align="center"><img width="466" src="https://raw.githubusercontent.com/objectbox/objectbox-java/master/logo.png" alt="ObjectBox"></p>
22

33
<p align="center">
44
<a href="https://docs.objectbox.io/getting-started">Getting Started</a> •
@@ -8,7 +8,7 @@
88
</p>
99

1010
<p align="center">
11-
<a href="https://docs.objectbox.io/#objectbox-changelog">
11+
<a href="https://github.com/objectbox/objectbox-java/releases/latest">
1212
<img src="https://img.shields.io/github/v/release/objectbox/objectbox-java?color=7DDC7D&style=flat-square" alt="Latest Release">
1313
</a>
1414
<a href="https://github.com/objectbox/objectbox-java/stargazers">
@@ -29,7 +29,7 @@ Store and manage data effortlessly in your Android or JVM Linux, macOS or Window
2929
Easily manage vector data alongside your objects and perform superfast on-device vector search to empower your apps with RAG AI, generative AI, and similarity search.
3030
Enjoy exceptional speed, battery-friendly resource usage, and environmentally-friendly development. 💚
3131

32-
### Demo code
32+
## Demo code
3333

3434
```java
3535
// Java
@@ -50,6 +50,7 @@ box.put(playlist)
5050
```
5151

5252
## Table of Contents
53+
5354
- [Key Features](#key-features)
5455
- [Getting started](#getting-started)
5556
- [Gradle setup](#gradle-setup)
@@ -60,16 +61,18 @@ box.put(playlist)
6061
- [License](#license)
6162

6263
## Key Features
64+
6365
🧠 **First on-device vector database:** easily manage vector data and perform fast vector search
6466
🏁 **High performance:** exceptional speed, outperforming alternatives like SQLite and Realm in all CRUD operations.\
6567
💚 **Efficient Resource Usage:** minimal CPU, power and memory consumption for maximum flexibility and sustainability.\
6668
🔗 **[Built-in Object Relations](https://docs.objectbox.io/relations):** built-in support for object relations, allowing you to easily establish and manage relationships between objects.\
6769
👌 **Ease of use:** concise API that eliminates the need for complex SQL queries, saving you time and effort during development.
6870

6971
## Getting started
72+
7073
### Gradle setup
7174

72-
For Android projects, add the ObjectBox Gradle plugin to your root `build.gradle`:
75+
For Android projects, add the ObjectBox Gradle plugin to your root `build.gradle`:
7376

7477
```groovy
7578
buildscript {
@@ -98,13 +101,15 @@ apply plugin: "io.objectbox" // Add after other plugins.
98101
### First steps
99102

100103
Create a data object class `@Entity`, for example "Playlist".
101-
```
104+
105+
```kotlin
102106
// Kotlin
103107
@Entity data class Playlist( ... )
104108

105109
// Java
106110
@Entity public class Playlist { ... }
107111
```
112+
108113
Now build the project to let ObjectBox generate the class `MyObjectBox` for you.
109114

110115
Prepare the BoxStore object once for your app, e.g. in `onCreate` in your Application class:
@@ -121,22 +126,24 @@ Box<Playlist> box = boxStore.boxFor(Playlist.class);
121126

122127
The `Box` object gives you access to all major functions, like `put`, `get`, `remove`, and `query`.
123128

124-
For details please check the [docs](https://docs.objectbox.io).
129+
For details please check the [docs](https://docs.objectbox.io).
125130

126131
## Why use ObjectBox for Java data management?
127132

128-
ObjectBox is a NoSQL Java database designed for local data storage on resource-restricted devices, prioritizing
129-
offline-first functionality. It is a smart and sustainable choice for local data persistence in Java and Kotlin
133+
ObjectBox is a NoSQL Java database designed for local data storage on resource-restricted devices, prioritizing
134+
offline-first functionality. It is a smart and sustainable choice for local data persistence in Java and Kotlin
130135
applications. It offers efficiency, ease of use, and flexibility.
131136

132137
### Fast but resourceful
133-
Optimized for speed and minimal resource consumption, ObjectBox is an ideal solution for mobile devices. It has
134-
excellent performance, while also minimizing CPU, RAM, and power usage. ObjectBox outperforms SQLite and Realm across
138+
139+
Optimized for speed and minimal resource consumption, ObjectBox is an ideal solution for mobile devices. It has
140+
excellent performance, while also minimizing CPU, RAM, and power usage. ObjectBox outperforms SQLite and Realm across
135141
all CRUD (Create, Read, Update, Delete) operations. Check out our [Performance Benchmarking App repository](https://github.com/objectbox/objectbox-performance).
136142

137143
### Simple but powerful
138-
With its concise language-native API, ObjectBox simplifies development by requiring less code compared to SQLite. It
139-
operates on plain objects (POJOs) with built-in relations, eliminating the need to manage rows and columns. This
144+
145+
With its concise language-native API, ObjectBox simplifies development by requiring less code compared to SQLite. It
146+
operates on plain objects (POJOs) with built-in relations, eliminating the need to manage rows and columns. This
140147
approach is efficient for handling large data volumes and allows for easy model modifications.
141148

142149
### Functionality
@@ -160,39 +167,41 @@ APIs. We genuinely want to hear from you: What do you love about ObjectBox? What
160167
challenges in everyday app development?
161168

162169
**We eagerly await your comments and requests, so please feel free to reach out to us:**
163-
- Add [GitHub issues](https://github.com/ObjectBox/objectbox-java/issues)
170+
171+
- Add [GitHub issues](https://github.com/ObjectBox/objectbox-java/issues)
164172
- Upvote important issues 👍
165173
- Drop us a line via [@ObjectBox_io](https://twitter.com/ObjectBox_io/) or contact[at]objectbox.io
166-
- ⭐ us on GitHub if you like what you see!
174+
- ⭐ us on GitHub if you like what you see!
167175

168176
Thank you! Stay updated with our [blog](https://objectbox.io/blog).
169177

170178
## Other languages/bindings
171179

172180
ObjectBox supports multiple platforms and languages.
173-
Besides JVM based languages like Java and Kotlin, ObjectBox also offers:
174-
175-
* [Swift Database](https://github.com/objectbox/objectbox-swift): build fast mobile apps for iOS (and macOS)
176-
* [Dart/Flutter Database](https://github.com/objectbox/objectbox-dart): cross-platform for mobile and desktop apps
177-
* [Go Database](https://github.com/objectbox/objectbox-go): great for data-driven tools and embedded server applications
178-
* [C and C++ Database](https://github.com/objectbox/objectbox-c): native speed with zero copy access to FlatBuffer objects
181+
Besides JVM based languages like Java and Kotlin, ObjectBox also offers:
179182

183+
- [Swift Database](https://github.com/objectbox/objectbox-swift): build fast mobile apps for iOS (and macOS)
184+
- [Dart/Flutter Database](https://github.com/objectbox/objectbox-dart): cross-platform for mobile and desktop apps
185+
- [Go Database](https://github.com/objectbox/objectbox-go): great for data-driven tools and embedded server applications
186+
- [C and C++ Database](https://github.com/objectbox/objectbox-c): native speed with zero copy access to FlatBuffer objects
180187

181188
## License
182189

183-
Copyright 2017-2024 ObjectBox Ltd. All rights reserved.
184-
185-
Licensed under the Apache License, Version 2.0 (the "License");
186-
you may not use this file except in compliance with the License.
187-
You may obtain a copy of the License at
188-
189-
http://www.apache.org/licenses/LICENSE-2.0
190-
191-
Unless required by applicable law or agreed to in writing, software
192-
distributed under the License is distributed on an "AS IS" BASIS,
193-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
194-
See the License for the specific language governing permissions and
195-
limitations under the License.
190+
```text
191+
Copyright 2017-2024 ObjectBox Ltd. All rights reserved.
192+
193+
Licensed under the Apache License, Version 2.0 (the "License");
194+
you may not use this file except in compliance with the License.
195+
You may obtain a copy of the License at
196+
197+
http://www.apache.org/licenses/LICENSE-2.0
198+
199+
Unless required by applicable law or agreed to in writing, software
200+
distributed under the License is distributed on an "AS IS" BASIS,
201+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
202+
See the License for the specific language governing permissions and
203+
limitations under the License.
204+
```
196205

197206
Note that this license applies to the code in this repository only.
198207
See our website on details about all [licenses for ObjectBox components](https://objectbox.io/faq/#license-pricing).

0 commit comments

Comments
 (0)