aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorTomáš Znamenáček2015-01-09 11:15:32 +0100
committerTomáš Znamenáček2015-01-09 11:15:32 +0100
commit1707e06678c1d3eca45f5763720364b3481d3a86 (patch)
treeca037115b3c6a54678f8b97eb655fe15c88e28d1 /README.md
parentf63c21e11cfad4fb8408effae2efb07164ad5760 (diff)
downloadMASShortcut-1707e06678c1d3eca45f5763720364b3481d3a86.tar.bz2
Added CocoaPods installation instructions (#54).
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
index a4ea509..d90bc0f 100644
--- a/README.md
+++ b/README.md
@@ -4,11 +4,23 @@ Some time ago Cocoa developers used a brilliant framework [ShortcutRecorder](htt
The MASShortcut project introduces a modern API and user interface for recording, storing and using system-wide keyboard shortcuts. All code is compatible with recent Xcode & OS X versions and the sandboxed environment.
+# Installation
+
+You can use [CocoaPods](http://cocoapods.org/), adding the following line to your Podfile:
+
+ pod 'MASShortcut'
+
+If you want to stick to the 1.x branch, you can use the version smart match operator:
+
+ pod 'MASShortcut', '~> 1'
+
# Usage
I hope, it is really easy:
```objective-c
+#import <MASShortcut/Shortcut.h>
+
// Drop a custom view into XIB, set its class to MASShortcutView
// and its height to 19. If you select another appearance style,
// look up the correct height values in MASShortcutView.h.