Skip to content

Commit 3d75792

Browse files
committed
Go in a little more detail on the macOS and iOS examples.
1 parent 93acb33 commit 3d75792

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,15 +46,15 @@ e.g. check the [getting started guide] or the [example](#example) described belo
4646

4747
### <a name="new-to-cocoapods"></a>New to CocoaPods?
4848

49-
[CocoaPods](https://cocoapods.org) it is a dependency manager and sets up libraries like ObjectBox in your xcode project.
49+
[CocoaPods](https://cocoapods.org) is a dependency manager and sets up libraries like ObjectBox in your xcode project.
5050
To install it, run this in a terminal:
5151

5252
```bash
5353
sudo gem install cocoapods
5454
```
5555

5656
In CocoaPods, you keep track of used libraries in a file called "Podfile".
57-
If you don't have this file yet, navigate to your xcode project folder and use CocoaPod to create one:
57+
If you don't have this file yet, navigate to your xcode project folder and use CocoaPods to create one:
5858

5959
```bash
6060
pod init
@@ -68,8 +68,8 @@ If `pod install` fails, try updating CocoaPods first:
6868

6969
<a name="example"></a>Example
7070
-----------------------------
71-
In the [Example](Example/) directory, you find a notes example app demonstrating ObjectBox's Swift API.
72-
The example comes with two apps: one for iOS and one for macOS.
71+
In the [Example](Example/) directory, you'll find a "Notes" example app demonstrating ObjectBox's Swift API.
72+
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.
7373

7474
To setup the example, use CocoaPods to acquire the framework:
7575

@@ -104,7 +104,9 @@ For general news on ObjectBox, [check our blog](https://objectbox.io/blog).
104104
Background: code generation
105105
---------------------------
106106
ObjectBox Swift generates code at build time for optimal performance at runtime by avoiding reflection etc.
107+
107108
This is automatically done for you and should be transparent.
109+
108110
Internally, we use [a fork of Sourcery](https://github.com/objectbox/objectbox-swift-generator) for this.
109111

110112
Source code

0 commit comments

Comments
 (0)