Skip to content

Commit 399af1c

Browse files
committed
Merge remote-tracking branch 'github/main'
2 parents 06a6e89 + 279999b commit 399af1c

File tree

1 file changed

+66
-25
lines changed

1 file changed

+66
-25
lines changed

README.md

Lines changed: 66 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,35 @@
1-
<img width="466" src="https://raw.githubusercontent.com/objectbox/objectbox-swift/master/images/logo.png">
2-
3-
Swift Database - swiftly persist objects on iOS and macOS
1+
<p align="center">
2+
<img width="466" src="https://raw.githubusercontent.com/objectbox/objectbox-swift/master/images/logo.png">
3+
</p>
4+
5+
<p align="center">
6+
<a href="https://swift.objectbox.io/getting-started">Getting Started</a> •
7+
<a href="https://swift.objectbox.io">Documentation</a> •
8+
<a href="https://github.com/objectbox/objectbox-dart/tree/main/objectbox/example">Example Apps</a> •
9+
<a href="https://github.com/objectbox/objectbox-dart/issues">Issues</a>
10+
</p>
11+
12+
<p align="center">
13+
<a href="#cocoapods">
14+
<img src="https://img.shields.io/cocoapods/v/ObjectBox.svg?style=flat-square" alt="Version">
15+
</a>
16+
<a href="#cocoapods">
17+
<img src="https://img.shields.io/cocoapods/p/ObjectBox.svg?style=flat-square&color=17A6A6" alt="Platform">
18+
</a>
19+
<a href="https://github.com/objectbox/objectbox-swift/blob/main/LICENSE.txt">
20+
<img src="https://img.shields.io/github/license/objectbox/objectbox-swift?logo=apache&style=flat-square" alt="Apache 2.0 license">
21+
</a>
22+
<a href="https://twitter.com/ObjectBox_io">
23+
<img src="https://img.shields.io/twitter/follow/objectbox_io?color=%20%2300aced&logo=twitter&style=flat-square" alt="Follow @ObjectBox_io">
24+
</a>
25+
</p>
26+
27+
Swift Database - swiftly persist objects on iOS & macOS
428
===============
5-
[![Version](https://img.shields.io/cocoapods/v/ObjectBox.svg?style=flat)](#cocoapods)
6-
[![Platform](https://img.shields.io/cocoapods/p/ObjectBox.svg?style=flat)](#cocoapods)
729

8-
ObjectBox is a superfast, light-weight Swift database persisting Swift objects fast, easily, and fully ACID-compliant on-device on iOS and macOS.
9-
On top, it comes with an [out-of-the-box Data Sync](https://objectbox.io/sync/) handling the complexity of occassionally connected devices, networking and conflict resolution code for you. Build apps that reliably sync between devices and any backend, offline on-premise or online with the Cloud.
30+
Powerful & superfast database for Swift that's also easy to use. Persist Swift objects quickly and reliably on-device on iOS and macOS.
31+
32+
## Demo code
1033

1134
```swift
1235
let santa = Person(firstName: "Santa", lastName: "Claus")
@@ -22,10 +45,29 @@ let oldClauses = query.find()
2245
Want details? **[Read the guides](https://swift.objectbox.io/)** or
2346
**[check out the API docs](https://objectbox.io/docfiles/swift/current/)**.
2447

25-
High-performance Swift database
26-
-------------
48+
## Table of Contents
49+
- [Why use ObjectBox for Swift data persistence?](#why-use-objectbox-for-swift-data-persistence)
50+
- [Features](#features)
51+
- [Adding ObjectBox to your project](#adding-objectbox-to-your-project)
52+
- [New to CocoaPods?](#new-to-cocoapods)
53+
- [CocoaPods troubleshooting](#cocoapods-troubleshooting)
54+
- [Swift Versions](#swift-versions)
55+
- [Example](#example)
56+
- [Background: code generation](#background-code-generation)
57+
- [Source code](#source-code)
58+
- [Already using ObjectBox?](#already-using-objectbox)
59+
- [Cross-platform database: Mobile, Desktop, Browser, Embedded, IoT](#cross-platform-database-mobile-desktop-browser-embedded-iot)
60+
- [License](#license)
61+
62+
## Why use ObjectBox for Swift data persistence?
63+
64+
Simple but powerful; frugal but fast: The ObjectBox NoSQL database offers an intuitive Swift API that's easy to pick up, fun to work with, and incredibly fast, making it sustainable in many ways. Its frugal recource use (CPU, memory, battery / power) makes ObjectBox an ideal and sustainable choice for iOS apps. So why not give it a try right away? Check out the [installation section below](#adding-objectbox-to-your-project). You can also star this repository for later 🌟
65+
66+
On top, ObjectBox comes with an [out-of-the-box Data Sync](https://objectbox.io/sync/) handling the complexity of occassionally connected devices, networking and conflict resolution code for you. Build apps that reliably sync between devices and any backend, offline on-premise or online with the Cloud.
67+
68+
### Features
2769
🏁 **High performance** on restricted devices, like IoT gateways, micro controllers, ECUs etc.\
28-
🪂 **Resourceful** with minimal CPU, power and Memory usage for maximum flexibility and sustainability\
70+
💚 **Resourceful** with minimal CPU, power and Memory usage for maximum flexibility and sustainability\
2971
🔗 **Relations:** object links / relationships are built-in\
3072
💻 **Multiplatform:** Linux, Windows, Android, iOS, macOS
3173

@@ -38,7 +80,6 @@ High-performance Swift database
3880
👥 **[ObjectBox Sync](https://objectbox.io/sync/):** keeps data in sync between devices and servers\
3981
🕒 **[ObjectBox TS](https://objectbox.io/time-series-database/):** time series extension for time based data
4082

41-
Enjoy ❤️
4283

4384
<a name="cocoapods"></a>Adding ObjectBox to your project
4485
--------------------------------------------------------
@@ -124,22 +165,10 @@ Source code
124165
-----------
125166
Source code for ObjectBox's Swift binding can be found [in the Source folder](Source/README.md).
126167

127-
Cross-platform database: Mobile, Desktop, Browser, Embedded, IoT
128-
------------------------
129-
ObjectBox is a cross-platform database supporting [multiple native languages](https://objectbox.io/dev-get-started/):
130-
131-
* [ObjectBox Java/Kotlin Database](https://github.com/objectbox/objectbox-java): runs on Android, desktop, and servers.
132-
* [Golang Data Persistence](https://github.com/objectbox/objectbox-go): great for IoT, data-driven tools, and server applications.
133-
* [C and C++ Database](https://github.com/objectbox/objectbox-c): native speed with zero copy access to objects on embedded devices
134-
also enables porting ObjectBox to other languages.
135-
* [Flutter/Dart Database](https://github.com/objectbox/objectbox-dart/): persist Dart objects & build cross-platform apps using Flutter.
136-
137-
How can I help ObjectBox?
168+
Already using ObjectBox?
138169
---------------------------
139-
We're on a mission to bring joy and delight to Mobile app developers.
140-
We want ObjectBox not only to be the fastest Swift database, but also the swiftiest Swift data persistence, making you enjoy coding with ObjectBox.
141170

142-
To do that, we want your feedback: what do you love? What's amiss? Where do you struggle in everyday app development?
171+
We're on a mission to bring joy, delight and sustainability to app developers. **To do this, we need your help:** Please fill in this 2-minute [Anonymous Feedback Form](https://forms.gle/LvVjN6jfFHuivxZX6). Let us know what you love and what is amiss, so we can improve.
143172

144173
**We're looking forward to receiving your comments and requests:**
145174

@@ -152,6 +181,18 @@ Thank you! 🙏
152181

153182
Keep in touch: For general news on ObjectBox, [check our blog](https://objectbox.io/blog)!
154183

184+
185+
Cross-platform database: Mobile, Desktop, Browser, Embedded, IoT
186+
------------------------
187+
ObjectBox is a cross-platform database supporting sustainable app development in [multiple native languages](https://objectbox.io/dev-get-started/):
188+
189+
* [Java/Kotlin Database](https://github.com/objectbox/objectbox-java): runs on Android, desktop, and servers.
190+
* [Golang Database](https://github.com/objectbox/objectbox-go): great for IoT, data-driven tools, and server applications.
191+
* [C and C++ Database](https://github.com/objectbox/objectbox-c): native speed with zero copy access to objects on embedded devices
192+
also enables porting ObjectBox to other languages.
193+
* [Flutter/Dart Database](https://github.com/objectbox/objectbox-dart/): persist Dart objects & build cross-platform apps using Flutter.
194+
195+
155196
License
156197
-------
157198
All files in this repository are under the Apache 2 license:

0 commit comments

Comments
 (0)