Skip to content

Commit feeb2df

Browse files
committed
README.md: trying to improve installation guides, e.g. assisting with CocoaPods
1 parent 4820129 commit feeb2df

File tree

1 file changed

+32
-23
lines changed

1 file changed

+32
-23
lines changed

README.md

Lines changed: 32 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
ObjectBox Swift
44
===============
5-
65
[![Version](https://img.shields.io/cocoapods/v/ObjectBox.svg?style=flat)](https://cocoapods.org/pods/ObjectBox)
76
[![Platform](https://img.shields.io/cocoapods/p/ObjectBox.svg?style=flat)](https://cocoapods.org/pods/ObjectBox)
87

@@ -23,34 +22,52 @@ let oldClauses = query.find()
2322
Want details? **[Read the guides](https://swift.objectbox.io/)** or
2423
**[check out the API docs](https://objectbox.io/docfiles/swift/current/)**.
2524

26-
Note: This beta version is subject to change ([details below](#alpha)).
27-
2825
Installation
2926
------------
30-
31-
ObjectBox is available through [CocoaPods](https://cocoapods.org).
32-
To install the [pod](https://cocoapods.org/pods/ObjectBox), simply add the following line to your Podfile:
27+
[CocoaPods](https://cocoapods.org) is recommended to set up ObjectBox in your project.
28+
See the [installation docs](https://swift.objectbox.io/install) for alternative setups,
29+
or the [New to CocoaPods?](#new-to-cocoapods) section below for a quick intro.
30+
To install the [ObjectBox pod](https://cocoapods.org/pods/ObjectBox), add the following line to your Podfile:
3331

3432
```ruby
3533
pod 'ObjectBox'
3634
```
3735

38-
Then run
36+
Then run this to install the ObjectBox framework:
3937

4038
```bash
4139
cd /path/to/your/project/folder/ # whatever folder your Podfile is in.
4240
pod install
4341
Pods/ObjectBox/setup.rb myproject.xcodeproj # whatever your Xcode project is named
4442
```
4543

46-
afterwards to install the framework and its dependencies, and set up the code generator in your project.
44+
Now you are all set to define your first ObjectBox entities;
45+
e.g. check the [getting started guide] or the [example](#example) described below.
46+
47+
### <a name="new-to-cocoapods"></a>New to CocoaPods?
48+
49+
[CocoaPods](https://cocoapods.org) it is a dependency manager and sets up libraries like ObjectBox in your xcode project.
50+
To install it, run this in a terminal:
51+
52+
```bash
53+
sudo gem install cocoapods
54+
```
55+
56+
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:
58+
59+
```bash
60+
pod init
61+
```
62+
63+
### CocoaPods troubleshooting
4764

4865
If `pod install` fails, try updating CocoaPods first:
4966

5067
gem update xcodeproj && gem update cocoapods && pod repo update
5168

52-
Example
53-
-------
69+
<a name="example"></a>Example
70+
-----------------------------
5471
In the [Example](Example/) directory, you find a notes example app demonstrating ObjectBox's Swift API.
5572
The example comes with two apps: one for iOS and one for macOS.
5673

@@ -64,7 +81,6 @@ This will generate a `NotesExample.xcworkspace` that you can launch to try out O
6481

6582
How can ObjectBox Help You?
6683
---------------------------
67-
6884
We want ObjectBox to be not only the fastest, but also the most Swift-friendly persistence solution.
6985

7086
To do that, we want your feedback: what do you love? What's amiss?
@@ -78,28 +94,21 @@ We're looking forward to receiving your comments and requests:
7894

7995
Thank you!
8096

81-
<a name="beta"></a>
82-
What's Missing in the Beta?
83-
---------------------------
84-
85-
More relation types, data observers, object browser.
86-
This functionality is available at lower layers and has not yet been exposed to Swift.
87-
8897
Keep in touch
8998
-------------
9099
We're obviously not finished here.
91100
[Sign up here](https://objectbox.io/ios-alpha/) for future updates on ObjectBox Swift.
92101

93102
For general news on ObjectBox, [check our blog](https://objectbox.io/blog).
94103

95-
Background: Code generation
104+
Background: code generation
96105
---------------------------
97106
ObjectBox Swift generates code at build time for optimal performance at runtime by avoiding reflection etc.
98-
This is automatically done for you and should be transparent. Internally, we use [a fork of Sourcery](https://github.com/objectbox/objectbox-swift-generator) for this.
107+
This is automatically done for you and should be transparent.
108+
Internally, we use [a fork of Sourcery](https://github.com/objectbox/objectbox-swift-generator) for this.
99109

100-
Source Code
110+
Source code
101111
-----------
102-
103112
Source code for ObjectBox's Swift binding can be found [in the Source folder](Source/README.md).
104113

105114
Other languages/bindings
@@ -114,7 +123,7 @@ License
114123
-------
115124
All files in this repository are under the Apache 2 license:
116125

117-
Copyright 2018 ObjectBox Ltd. All rights reserved.
126+
Copyright 2018-2019 ObjectBox Ltd. All rights reserved.
118127

119128
Licensed under the Apache License, Version 2.0 (the "License");
120129
you may not use this file except in compliance with the License.

0 commit comments

Comments
 (0)