Skip to content

Commit 503c902

Browse files
committed
Example: add README.md and setup.sh
1 parent 69363ec commit 503c902

File tree

3 files changed

+29
-0
lines changed

3 files changed

+29
-0
lines changed

Example/Podfile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
#You don't need this, unless you want to get access to latest release candidates or preview versions:
12
#source 'https://github.com/objectbox/objectbox-swift-spec-staging'
23

34
use_frameworks!

Example/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
ObjectBox Example
2+
=================
3+
The "Notes" example app demonstrate ObjectBox's Swift API.
4+
The example comes with two apps: one for iOS and one for macOS. The iOS example is a full GUI application, whereas the macOS example runs a few operations and then exits.
5+
6+
Example setup
7+
-------------
8+
Just like in any other project, you need te setup CocoaPods and ObjectBox.
9+
Simply run `./setup.sh` inside this directory, or copy paste this into a terminal:
10+
11+
pod install # if that fails, update CocoaPods (see Installation)
12+
Pods/ObjectBox/setup.rb
13+
14+
This will generate a `NotesExample.xcworkspace` that you can launch to try out ObjectBox.
15+
16+
Updating to newer ObjectBox versions
17+
------------------------------------
18+
pod repo update
19+
pod update
20+
Pods/ObjectBox/setup.rb

Example/setup.sh

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
#!/usr/bin/env bash
2+
set -eu
3+
4+
# Typical ObjectBox project setup using CocoaPods; see https://swift.objectbox.io/install for details.
5+
6+
pod repo update
7+
pod install
8+
Pods/ObjectBox/setup.rb

0 commit comments

Comments
 (0)