Skip to content

Commit 66361ec

Browse files
committed
Add a minimal Readme file.
1 parent 4c9dc75 commit 66361ec

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
2+
ObjectBox iOS Example
3+
=====================
4+
5+
ObjectBox is a superfast, light-weight object persistence framework for iOS and macOS. This repository includes a notes example app for iOS that demonstrates ObjectBox's Swift API.
6+
7+
- **[Read the guides](https://swift.objectbox.io/)** for detailed explanations
8+
- [Check out the code on GitHub][swiftrepo]
9+
- [Visit our blog](https://objectbox.io/blog)
10+
11+
[swiftrepo]: https://github.com/ObjectBox/objectbox-swift
12+
[obio]: https://objectbox.io/
13+
14+
Building
15+
--------
16+
17+
The Example can be found in the `Example/` subfolder, and uses CocoaPods to acquire the framework:
18+
19+
cd Example/
20+
pod install
21+
22+
This will generate a `NotesExample.xcworkspace` that you can launch to try out ObjectBox.
23+
24+
Entity Files
25+
------------
26+
27+
You do not have to add the runtime info needed for serializing Objects to the database yourself. The project is automatically set up so it will use Sourcery to generate the required EntityInfo extensions on your Entity subclasses.
28+

0 commit comments

Comments
 (0)