Skip to content

Commit

Permalink
Correct podspecs and README
Browse files Browse the repository at this point in the history
  • Loading branch information
pasin committed Apr 12, 2018
1 parent ceb2047 commit 3a7b193
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 8 deletions.
4 changes: 2 additions & 2 deletions CouchbaseLiteSwift.podspec → CouchbaseLite-Swift.podspec
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Pod::Spec.new do |s|
s.name = 'CouchbaseLiteSwift'
s.name = 'CouchbaseLite-Swift'
s.version = '2.0.0'
s.license = 'Apache License, Version 2.0'
s.homepage = 'http://mobile.couchbase.com'
s.homepage = 'https://github.com/couchbase/couchbase-lite-ios'
s.summary = 'An embedded syncable NoSQL database for iOS and MacOS apps.'
s.author = 'Couchbase'
s.source = { :git => 'https://github.com/couchbase/couchbase-lite-ios.git', :tag => s.version, :submodules => true }
Expand Down
2 changes: 1 addition & 1 deletion CouchbaseLite.podspec
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Pod::Spec.new do |s|
s.name = 'CouchbaseLite'
s.version = '2.0.0'
s.license = 'Apache License, Version 2.0'
s.homepage = 'http://mobile.couchbase.com'
s.homepage = 'https://github.com/couchbase/couchbase-lite-ios'
s.summary = 'An embedded syncable NoSQL database for iOS and MacOS apps.'
s.author = 'Couchbase'
s.source = { :git => 'https://github.com/couchbase/couchbase-lite-ios.git', :tag => s.version, :submodules => true }
Expand Down
36 changes: 31 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,28 +17,54 @@ Couchbase Lite 2.0 has a completely new set of APIs. The implementation is on to

You can use [CocoaPods](https://cocoapods.org/) to install `CouchbaseLite` for Objective-C API or `CouchbaseLiteSwift` for Swift API by adding it in your [Podfile](https://guides.cocoapods.org/using/the-podfile.html):

#### CouchbaseLite (Objective-C API)
#### Objective-C

##### Community Edition
```
target '<your target name>' do
use_frameworks!
pod 'CouchbaseLite', '~> 2.0.0'
end
```

#### CouchbaseLiteSwift (Swift API)
##### Enterprise Edition
```
target '<your target name>' do
use_frameworks!
pod 'CouchbaseLiteSwift', '~> 2.0.0'
pod 'CouchbaseLite-Enterprise', '~> 2.0.0'
end
```

#### Swift

##### Community Edition
```
target '<your target name>' do
use_frameworks!
pod 'CouchbaseLite-Swift', '~> 2.0.0'
end
```

##### Enterprise Edition
```
target '<your target name>' do
use_frameworks!
pod 'CouchbaseLite-Swift-Enterprise', '~> 2.0.0'
end
```

### Carthage

You can use [Carthage](https://github.com/Carthage/Carthage) to install `CouchbaseLite` by adding it in your [Cartfile](https://github.com/Carthage/Carthage/blob/master/Documentation/Artifacts.md#cartfile):

##### Community Edition
```
binary "https://raw.githubusercontent.com/couchbase/couchbase-lite-ios/master/Release/Carthage/CouchbaseLite-Community.json" ~> 2.0.0
```

##### Enterprise Edition
```
github "couchbase/couchbase-lite-ios" "2.0.0"
binary "https://raw.githubusercontent.com/couchbase/couchbase-lite-ios/master/Release/Carthage/CouchbaseLite-Enterprise.json" ~> 2.0.0
```

> When running `carthage update or build`, Carthage will build both CouchbaseLite and CouchbaseLiteSwift framework.
Expand All @@ -53,7 +79,7 @@ $ git submodule update --init --recursive
$ cd couchbase-lite-ios
```

2. Run ./Scripts/build_framework.sh to build a platform framework which could be either an Objective-C or a Swift framework. The supported platforms include iOS and macOS.
2. Run ./Scripts/build_framework.sh to build a platform framework which could be either an Objective-C or a Swift framework. The supported platforms include iOS, tvOS, and macOS.

```
$ ./Scripts/build_framework.sh -s "CBL ObjC" -p iOS -o output // For building the ObjC framework for iOS
Expand Down

0 comments on commit 3a7b193

Please sign in to comment.