Skip to content

Commit f083152

Browse files
committed
README.md: mention supported platforms, improve "first steps" section
1 parent 1df25f6 commit f083152

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<img width="466" src="https://raw.githubusercontent.com/objectbox/objectbox-java/master/logo.png">
22

33
# ObjectBox Java (Kotlin, Android)
4-
ObjectBox is a superfast object-oriented database with strong relation support.
4+
ObjectBox is a superfast object-oriented database with strong relation support. ObjectBox is embedded into your Android, Linux, macOS, or Windows app.
55

66
**Latest version: [1.4.3 (2018/03/01)](http://objectbox.io/changelog)**
77

@@ -36,14 +36,19 @@ apply plugin: 'io.objectbox' // after applying Android plugin
3636

3737
First steps
3838
-----------
39+
Create data object class `@Entity`, for example "Playlist".
40+
```java
41+
@Entity public class Playlist { ... }
42+
```
43+
Now build the project to let ObjectBox generate the class `MyObjectBox` for you.
44+
3945
Prepare the BoxStore object once for your app, e.g. in `onCreate` in your Application class:
4046

4147
```java
4248
boxStore = MyObjectBox.builder().androidContext(this).build();
4349
```
4450

45-
Create data object class `@Entity`, for example "Playlist".
46-
Then get a `Box` class for this entity class:
51+
Then get a `Box` class for the Playlist entity class:
4752

4853
```java
4954
Box<Playlist> box = boxStore.boxFor(Playlist.class);
@@ -71,7 +76,7 @@ Thanks!
7176

7277
License
7378
-------
74-
Copyright 2017 ObjectBox Ltd. All rights reserved.
79+
Copyright 2017-2018 ObjectBox Ltd. All rights reserved.
7580

7681
Licensed under the Apache License, Version 2.0 (the "License");
7782
you may not use this file except in compliance with the License.

0 commit comments

Comments
 (0)