Skip to content

Commit 4204247

Browse files
committed
Merge pull request #39 from Khan/NachoSoto-patch-1
Added Carthage instructions and badges to README
2 parents ab6f91c + 6ad0fde commit 4204247

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
# SwiftTweaks
2+
3+
[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage) [![GitHub release](https://img.shields.io/github/release/Khan/SwiftTweaks.svg)](https://github.com/Khan/SwiftTweaks/releases) ![Swift 2.2.x](https://img.shields.io/badge/Swift-2.2.x-orange.svg) ![platforms](https://img.shields.io/badge/platforms-iOS%20-lightgrey.svg)
4+
25
Adjust your iOS app on the fly without needing to compile!
36
![Tweaks](https://github.com/Khan/SwiftTweaks/blob/master/Images/SwiftTweaks%20Overview.png?raw=true)
47

@@ -115,6 +118,13 @@ For more examples, check out the example project’s `ViewController.swift` file
115118
### Step Three: Set TweakWindow as your Root View Controller
116119
By default, SwiftTweaks uses a shake gesture to bring up the UI, but you can also use a custom gesture if you prefer it!
117120

121+
## Getting started
122+
123+
To add `SwiftTweaks` to your application, add it to your `Cartfile`:
124+
```
125+
github "Khan/SwiftTweaks"
126+
```
127+
118128
## FAQ
119129
#### Do I *have* to set TweakWindow as the root of my app?
120130
Nope! Wherever/however you prefer, just create a `TweaksViewController` like so:

0 commit comments

Comments
 (0)