Skip to content

Commit

Permalink
Fix Carthage instruction (#190)
Browse files Browse the repository at this point in the history
  • Loading branch information
Jeremy Chiang authored Jan 25, 2019
1 parent 753226d commit 320dc60
Show file tree
Hide file tree
Showing 7 changed files with 34 additions and 19 deletions.
4 changes: 2 additions & 2 deletions Bluejay.podspec
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
Pod::Spec.new do |spec|
spec.name = 'Bluejay'
spec.version = '0.8.0'
spec.version = '0.8.1'
spec.license = { type: 'MIT', file: 'LICENSE' }
spec.homepage = 'https://github.com/steamclock/bluejay'
spec.authors = { 'Jeremy Chiang' => '[email protected]' }
spec.summary = 'Bluejay is a simple Swift framework for building reliable Bluetooth apps.'
spec.homepage = 'https://github.com/steamclock/bluejay'
spec.source = { git: 'https://github.com/steamclock/bluejay.git', tag: 'v0.8.0' }
spec.source = { git: 'https://github.com/steamclock/bluejay.git', tag: 'v0.8.1' }
spec.source_files = 'Bluejay/Bluejay/*.{h,swift}'
spec.framework = 'SystemConfiguration'
spec.platform = :ios, '10.0'
Expand Down
2 changes: 1 addition & 1 deletion Bluejay/.jazzy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ output: ../docs
author: Steamclock Software
author_url: http://steamclock.com
module: Bluejay
module_version: 0.8.0
module_version: 0.8.1
readme: ../README.md
sdk: iphone
copyright: Copyright © 2017 Steamclock Software. All rights reserved.
Expand Down
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
## [Unreleased]
### Changed

## [0.8.1] - 2019-01-14
### Fixed
- Fixed and improved Carthage instruction

## [0.8.0] - 2019-01-11
### Added
- XCGLogger, and APIs for logging to a file and monitoring log file changes
Expand Down
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,19 +65,26 @@ Bluejay's primary goals are:

## Installation

Install using CocoaPods:
### CocoaPods

`pod 'Bluejay', '~> 0.8'`

Or to try the latest master:

`pod 'Bluejay', :git => 'https://github.com/steamclock/bluejay.git', :branch => 'master'`

Cartfile:
### Carthage

`github "steamclock/bluejay" ~> 0.8`
```
github "steamclock/bluejay" ~> 0.8
github "DaveWoodCom/XCGLogger" ~> 6.1.0
```

Refer to [official Carthage documentation](https://github.com/Carthage/Carthage#supporting-carthage-for-your-framework) for the rest of the instructions.

**Note:** `Bluejay.framework`, `ObjcExceptionBridging.framework`, and `XCGLogger.framework` are all required.

Import using:
### Import

```swift
import Bluejay
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -280,20 +280,22 @@ <h2 id='requirements' class='heading'>Requirements</h2>
<li>Swift 4.2 or above</li>
</ul>
<h2 id='installation' class='heading'>Installation</h2>

<p>Install using CocoaPods:</p>
<h3 id='cocoapods' class='heading'>CocoaPods</h3>

<p><code>pod &#39;Bluejay&#39;, &#39;~&gt; 0.8&#39;</code></p>

<p>Or to try the latest master:</p>

<p><code>pod &#39;Bluejay&#39;, :git =&gt; &#39;https://github.com/steamclock/bluejay.git&#39;, :branch =&gt; &#39;master&#39;</code></p>
<h3 id='carthage' class='heading'>Carthage</h3>
<pre class="highlight plaintext"><code>github "steamclock/bluejay" ~&gt; 0.8
github "DaveWoodCom/XCGLogger" ~&gt; 6.1.0
</code></pre>

<p>Cartfile:</p>

<p><code>github &quot;steamclock/bluejay&quot; ~&gt; 0.8</code></p>
<p>Refer to <a href="https://github.com/Carthage/Carthage#supporting-carthage-for-your-framework">official Carthage documentation</a> for the rest of the instructions.</p>

<p>Import using:</p>
<p><strong>Note:</strong> <code>Bluejay.framework</code>, <code>ObjcExceptionBridging.framework</code>, and <code>XCGLogger.framework</code> are all required.</p>
<h3 id='import' class='heading'>Import</h3>
<pre class="highlight swift"><code><span class="kd">import</span> <span class="kt">Bluejay</span>
</code></pre>
<h2 id='demo' class='heading'>Demo</h2>
Expand Down
Binary file modified docs/docsets/Bluejay.tgz
Binary file not shown.
14 changes: 8 additions & 6 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -280,20 +280,22 @@ <h2 id='requirements' class='heading'>Requirements</h2>
<li>Swift 4.2 or above</li>
</ul>
<h2 id='installation' class='heading'>Installation</h2>

<p>Install using CocoaPods:</p>
<h3 id='cocoapods' class='heading'>CocoaPods</h3>

<p><code>pod &#39;Bluejay&#39;, &#39;~&gt; 0.8&#39;</code></p>

<p>Or to try the latest master:</p>

<p><code>pod &#39;Bluejay&#39;, :git =&gt; &#39;https://github.com/steamclock/bluejay.git&#39;, :branch =&gt; &#39;master&#39;</code></p>
<h3 id='carthage' class='heading'>Carthage</h3>
<pre class="highlight plaintext"><code>github "steamclock/bluejay" ~&gt; 0.8
github "DaveWoodCom/XCGLogger" ~&gt; 6.1.0
</code></pre>

<p>Cartfile:</p>

<p><code>github &quot;steamclock/bluejay&quot; ~&gt; 0.8</code></p>
<p>Refer to <a href="https://github.com/Carthage/Carthage#supporting-carthage-for-your-framework">official Carthage documentation</a> for the rest of the instructions.</p>

<p>Import using:</p>
<p><strong>Note:</strong> <code>Bluejay.framework</code>, <code>ObjcExceptionBridging.framework</code>, and <code>XCGLogger.framework</code> are all required.</p>
<h3 id='import' class='heading'>Import</h3>
<pre class="highlight swift"><code><span class="kd">import</span> <span class="kt">Bluejay</span>
</code></pre>
<h2 id='demo' class='heading'>Demo</h2>
Expand Down

0 comments on commit 320dc60

Please sign in to comment.