Skip to content

Commit 279999b

Browse files
Update README (#70)
1 parent 591a145 commit 279999b

File tree

1 file changed

+41
-21
lines changed

1 file changed

+41
-21
lines changed

README.md

Lines changed: 41 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,35 @@
1-
<img width="466" src="https://raw.githubusercontent.com/objectbox/objectbox-swift/master/images/logo.png">
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>
226

327
Swift Database - swiftly persist objects on iOS & macOS
428
===============
529

6-
[![Version](https://img.shields.io/cocoapods/v/ObjectBox.svg?style=flat)](#cocoapods)
7-
[![Platform](https://img.shields.io/cocoapods/p/ObjectBox.svg?style=flat)](#cocoapods)
30+
Powerful & superfast database for Swift that's also easy to use. Persist Swift objects quickly and reliably on-device on iOS and macOS.
831

9-
10-
**Your opinion matters to us!** Please fill in this 2-minute [Anonymous Feedback Form](https://forms.gle/LvVjN6jfFHuivxZX6).
11-
12-
ObjectBox is a superfast, light-weight Swift database persisting Swift objects fast, easily, and fully ACID-compliant on-device on iOS and macOS.
13-
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.
32+
## Demo code
1433

1534
```swift
1635
let santa = Person(firstName: "Santa", lastName: "Claus")
@@ -27,7 +46,8 @@ Want details? **[Read the guides](https://swift.objectbox.io/)** or
2746
**[check out the API docs](https://objectbox.io/docfiles/swift/current/)**.
2847

2948
## Table of Contents
30-
- [Features](#features)
49+
- [Why use ObjectBox for Swift data persistence?](#why-use-objectbox-for-swift-data-persistence)
50+
- [Features](#features)
3151
- [Adding ObjectBox to your project](#adding-objectbox-to-your-project)
3252
- [New to CocoaPods?](#new-to-cocoapods)
3353
- [CocoaPods troubleshooting](#cocoapods-troubleshooting)
@@ -38,12 +58,16 @@ Want details? **[Read the guides](https://swift.objectbox.io/)** or
3858
- [Already using ObjectBox?](#already-using-objectbox)
3959
- [Cross-platform database: Mobile, Desktop, Browser, Embedded, IoT](#cross-platform-database-mobile-desktop-browser-embedded-iot)
4060
- [License](#license)
41-
<hr/>
4261

43-
Features
44-
-------------
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
4569
🏁 **High performance** on restricted devices, like IoT gateways, micro controllers, ECUs etc.\
46-
🪂 **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\
4771
🔗 **Relations:** object links / relationships are built-in\
4872
💻 **Multiplatform:** Linux, Windows, Android, iOS, macOS
4973

@@ -56,8 +80,6 @@ Features
5680
👥 **[ObjectBox Sync](https://objectbox.io/sync/):** keeps data in sync between devices and servers\
5781
🕒 **[ObjectBox TS](https://objectbox.io/time-series-database/):** time series extension for time based data
5882

59-
Enjoy ❤️
60-
6183

6284
<a name="cocoapods"></a>Adding ObjectBox to your project
6385
--------------------------------------------------------
@@ -143,9 +165,7 @@ Source code for ObjectBox's Swift binding can be found [in the Source folder](So
143165
Already using ObjectBox?
144166
---------------------------
145167

146-
We're on a mission to bring joy and delight to Mobile app developers. We want ObjectBox not only to be the fastest Swift database, but also the swiftiest Swift data persistence, making you enjoy coding with ObjectBox.
147-
148-
To do that, we want your feedback: what do you love? What's amiss? Where do you struggle in everyday app development?
168+
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.
149169

150170
**We're looking forward to receiving your comments and requests:**
151171

@@ -161,10 +181,10 @@ Keep in touch: For general news on ObjectBox, [check our blog](https://objectbox
161181

162182
Cross-platform database: Mobile, Desktop, Browser, Embedded, IoT
163183
------------------------
164-
ObjectBox is a cross-platform database supporting [multiple native languages](https://objectbox.io/dev-get-started/):
184+
ObjectBox is a cross-platform database supporting sustainable app development in [multiple native languages](https://objectbox.io/dev-get-started/):
165185

166-
* [ObjectBox Java/Kotlin Database](https://github.com/objectbox/objectbox-java): runs on Android, desktop, and servers.
167-
* [Golang Data Persistence](https://github.com/objectbox/objectbox-go): great for IoT, data-driven tools, and server applications.
186+
* [Java/Kotlin Database](https://github.com/objectbox/objectbox-java): runs on Android, desktop, and servers.
187+
* [Golang Database](https://github.com/objectbox/objectbox-go): great for IoT, data-driven tools, and server applications.
168188
* [C and C++ Database](https://github.com/objectbox/objectbox-c): native speed with zero copy access to objects on embedded devices
169189
also enables porting ObjectBox to other languages.
170190
* [Flutter/Dart Database](https://github.com/objectbox/objectbox-dart/): persist Dart objects & build cross-platform apps using Flutter.

0 commit comments

Comments
 (0)