Skip to content

Commit e8cd54d

Browse files
Merge branch '300-swift-package-instructions' into 'main'
README: update for Swift Package, refer to GitBook See merge request objectbox/objectbox-swift-public!19
2 parents ec23f50 + a2d4bf9 commit e8cd54d

File tree

1 file changed

+10
-47
lines changed

1 file changed

+10
-47
lines changed

README.md

Lines changed: 10 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
</a>
2222
</p>
2323

24-
# Swift Database - swiftly persist objects and on-device vector database for iOS & macOS
24+
# ObjectBox Swift Database - swiftly persist objects and on-device vector database for iOS & macOS
2525

2626
Powerful & superfast database for Swift that's also easy to use. Persist Swift objects quickly and reliably on-device on iOS and macOS.
2727

@@ -68,7 +68,7 @@ Want details? **[Read the guides](https://swift.objectbox.io/)** or
6868

6969
## Why use ObjectBox for Swift data persistence?
7070

71-
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 🌟
71+
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](#add-objectbox-to-your-project). You can also star this repository for later 🌟
7272

7373
### Features
7474

@@ -87,51 +87,14 @@ Simple but powerful; frugal but fast: The ObjectBox NoSQL database offers an int
8787
👥 **[ObjectBox Sync](https://objectbox.io/sync/):** keeps data in sync between devices and servers\
8888
🕒 **[ObjectBox TS](https://objectbox.io/time-series-database/):** time series extension for time based data
8989

90-
<a name="cocoapods"></a>
90+
## Add ObjectBox to your project
9191

92-
## Adding ObjectBox to your project
92+
ObjectBox is available as a
9393

94-
ObjectBox is available as a [CocoaPods](https://cocoapods.org) pod. [See the docs](https://swift.objectbox.io/install) for details and alternative setup options.
94+
- [CocoaPods](https://swift.objectbox.io/install#cocoapods) pod
95+
- [Swift Package](https://swift.objectbox.io/install#swift-package)
9596

96-
If you are new to CocoaPods, [check out their website](https://cocoapods.org) for an introduction and installation instructions.
97-
98-
To add the ObjectBox Swift dependency, add the following line to your `Podfile`:
99-
100-
```ruby
101-
pod 'ObjectBox'
102-
```
103-
104-
Then run these commands in your project directory to install the ObjectBox framework:
105-
106-
```bash
107-
pod install --repo-update
108-
Pods/ObjectBox/setup.rb
109-
```
110-
111-
Then open your Xcode workspace (.xcworkspace) instead of the Xcode project (.xcodeproj).
112-
113-
Now, you are all set to define your first ObjectBox entities;
114-
e.g. check the [getting started guide](https://swift.objectbox.io/getting-started) or the [example](#example) described below.
115-
116-
### CocoaPods troubleshooting
117-
118-
If `pod install` fails, try updating CocoaPods first:
119-
120-
```bash
121-
gem update xcodeproj && gem update cocoapods && pod repo update
122-
```
123-
124-
## Updating to newer ObjectBox versions
125-
126-
Update the ObjectBox pod and re-run the setup script:
127-
128-
```shell
129-
pod repo update
130-
pod update ObjectBox
131-
Pods/ObjectBox/setup.rb
132-
```
133-
134-
<a name="example"></a>
97+
See [Install ObjectBox Swift](https://swift.objectbox.io/install) for details and alternative setup options.
13598

13699
## Example
137100

@@ -171,9 +134,9 @@ The source code for ObjectBox's Swift binding can be found [in the Source folder
171134

172135
## Background: code generation
173136

174-
ObjectBox Swift Database generates code at build time for optimal performance at runtime by avoiding reflection etc.
175-
This is automatically done for you and should be transparent.
176-
Internally, we use [a fork of Sourcery](https://github.com/objectbox/objectbox-swift-generator) for this.
137+
ObjectBox Swift Database uses generated code for optimal performance at runtime by avoiding reflection etc.
138+
139+
It uses [a fork of Sourcery](https://github.com/objectbox/objectbox-swift-generator) for this.
177140

178141
## Already using ObjectBox?
179142

0 commit comments

Comments
 (0)