Skip to content

Commit 73b0883

Browse files
author
Daniel Dahan
committed
added installation instructions to README
1 parent 09f0ef3 commit 73b0883

File tree

3 files changed

+47
-3
lines changed

3 files changed

+47
-3
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
## 3.1.1
2+
3+
* Added installation instructions to README.
4+
15
## 2.1.1
26

37
* Updated for Swift 4.1.

README.md

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,50 @@ Algorithm is a library of tools that is used to create intelligent applications.
3939

4040
## Installation
4141

42-
> **Embedded frameworks require a minimum deployment target of iOS 8 or OS X Mavericks (10.9).**
42+
> **Embedded frameworks require a minimum deployment target of iOS 8.**
4343
> - [Download Algorithm](https://github.com/CosmicMind/Algorithm/archive/master.zip)
4444
45-
Visit the [Installation](https://github.com/CosmicMind/Algorithm/wiki/Installation) page to learn how to install Algorithm using [CocoaPods](http://cocoapods.org) and [Carthage](https://github.com/Carthage/Carthage).
45+
## CocoaPods
46+
47+
[CocoaPods](http://cocoapods.org) is a dependency manager for Cocoa projects. You can install it with the following command:
48+
49+
```bash
50+
$ gem install cocoapods
51+
```
52+
53+
To integrate Algorithm's core features into your Xcode project using CocoaPods, specify it in your `Podfile`:
54+
55+
```ruby
56+
source 'https://github.com/CocoaPods/Specs.git'
57+
platform :ios, '8.0'
58+
use_frameworks!
59+
60+
pod 'Algorithm', '~> 3.1.0'
61+
```
62+
63+
Then, run the following command:
64+
65+
```bash
66+
$ pod install
67+
```
68+
69+
## Carthage
70+
71+
Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.
72+
73+
You can install Carthage with Homebrew using the following command:
74+
75+
```bash
76+
$ brew update
77+
$ brew install carthage
78+
```
79+
To integrate Algorithm into your Xcode project using Carthage, specify it in your Cartfile:
80+
81+
```bash
82+
github "CosmicMind/Algorithm"
83+
```
84+
85+
Run `carthage update` to build the framework and drag the built `Algorithm.framework` into your Xcode project.
4686

4787
## Changelog
4888

Sources/Info.plist

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
<key>CFBundlePackageType</key>
1616
<string>FMWK</string>
1717
<key>CFBundleShortVersionString</key>
18-
<string>3.1.0</string>
18+
<string>3.1.1</string>
1919
<key>CFBundleSignature</key>
2020
<string>????</string>
2121
<key>CFBundleVersion</key>

0 commit comments

Comments
 (0)