Updated CHANGES, Info.plist and podspec for the 2.2.0 release.

Some fix

CHANGES

@@ -1,3 +1,14 @@
+2.2.0 2015/8/18
+    - Basic accessibility support [starkos]
+    - Added an option to hide the shortcut delete button [oreshinya]
+    - Advertised support for Carthage [Tom Brown]
+    - Bugfix for shortcuts not working after set twice [Roman Sokolov]
+    - Ignore a solo Tab key when recording shortcuts [Roman Sokolov]
+
+2.1.2 2015/1/28
+    - Better key equivalent handling for non-ASCII layouts.
+      [Dmitry Obukhov]
+
 2.1.1 2015/1/16
     - Another headerdoc fix for CocoaDocs, hopefully the last one.
 

CONTRIBUTING.md

@@ -0,0 +1,21 @@
+# How to Release a New Version
+
+First, update the version numbers. (MASShortcut uses [Semantic Versioning](http://semver.org/), so please read the docs if you’re not sure what the deal is.) The version number is stored in `Framework/Info.plist` and `MASShortcut.podspec` (twice in both files).
+
+Then update the `CHANGES` file. Add information about the new version (see the previous versions for an example) and add the release date.
+
+Now commit the changes:
+
+    $ git commit -a -m "Version bump to x.y.z."
+
+And tag the last commit:
+
+    $ git tag -a x.y.z
+
+Now push both the commits and tags (`--tags`) to GitHub and push the new podspec to CocoaPods:
+
+    $ pod trunk push MASShortcut.podspec
+
+This will run sanity checks on the podspec and fail if the spec does not validate.
+
+That’s it. Go have a beer or a cup of tea to celebrate.

Framework/Info.plist

@@ -15,9 +15,9 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>2.1.1</string>
+	<string>2.2.0</string>
 	<key>CFBundleVersion</key>
-	<string>2.1.1</string>
+	<string>2.2.0</string>
 	<key>NSHumanReadableCopyright</key>
 	<string>Copyright © 2014–2015 Vadim Shpakovski. All rights reserved.</string>
 </dict>

Framework/MASKeyCodes.h

@@ -1,4 +1,5 @@
 #import <Carbon/Carbon.h>
+#import <AppKit/AppKit.h>
 
 // These glyphs are missed in Carbon.h
 enum {
@@ -20,7 +21,7 @@ enum {
     kMASShortcutGlyphPadClear = 0x2327,
     kMASShortcutGlyphNorthwestArrow = 0x2196,
     kMASShortcutGlyphSoutheastArrow = 0x2198,
-} MASShortcutGlyph;
+};
 
 NS_INLINE NSString* NSStringFromMASKeyCode(unsigned short ch)
 {

Framework/MASShortcut.h

@@ -39,6 +39,11 @@
 
 /**
  A string representing the “key” part of a shortcut, like the `5` in `⌘5`.
+
+ @warning The value may change depending on the active keyboard layout.
+ For example for the `^2` keyboard shortcut (`kVK_ANSI_2+NSControlKeyMask`
+ to be precise) the `keyCodeString` is `2` on the US keyboard, but `ě` when
+ the Czech keyboard layout is active. See the spec for details.
 */
 @property (nonatomic, readonly) NSString *keyCodeString;
 
@@ -49,6 +54,12 @@
  property of `NSMenuItem`. Here the string is used to support shortcut
  validation (“is the shortcut already taken in this menu?”) and
  for display in `NSMenu`.
+
+ The value of this property may differ from `keyCodeString`. For example
+ the Russian keyboard has a `Г` (Ge) Cyrillic character in place of the
+ latin `U` key. This means you can create a `^Г` shortcut, but in menus
+ that’s always displayed as `^U`. So the `keyCodeString` returns `Г`
+ and `keyCodeStringForKeyEquivalent` returns `U`.
 */
 @property (nonatomic, readonly) NSString *keyCodeStringForKeyEquivalent;
 

Framework/MASShortcut.m

@@ -139,10 +139,10 @@ static NSString *const MASShortcutModifierFlags = @"ModifierFlags";
         case 115: return NSStringFromMASKeyCode(kMASShortcutGlyphNorthwestArrow);
     }
     
-    // Everything else should be printable so look it up in the current keyboard
+    // Everything else should be printable so look it up in the current ASCII capable keyboard layout
     OSStatus error = noErr;
     NSString *keystroke = nil;
-    TISInputSourceRef inputSource = TISCopyCurrentKeyboardLayoutInputSource();
+    TISInputSourceRef inputSource = TISCopyCurrentASCIICapableKeyboardLayoutInputSource();
     if (inputSource) {
         CFDataRef layoutDataRef = TISGetInputSourceProperty(inputSource, kTISPropertyUnicodeKeyLayoutData);
         if (layoutDataRef) {

Framework/MASShortcut.modulemap

@@ -0,0 +1,6 @@
+framework module MASShortcut {
+  umbrella header "Shortcut.h"
+  
+  export *
+  module * { export * }
+}

Framework/MASShortcutBinder.m

@@ -41,9 +41,15 @@
 
 - (void) bindShortcutWithDefaultsKey: (NSString*) defaultsKeyName toAction: (dispatch_block_t) action
 {
+    NSAssert([defaultsKeyName rangeOfString:@"."].location == NSNotFound,
+        @"Illegal character in binding name (“.”), please see http://git.io/x5YS.");
+    NSAssert([defaultsKeyName rangeOfString:@" "].location == NSNotFound,
+        @"Illegal character in binding name (“ ”), please see http://git.io/x5YS.");
     [_actions setObject:[action copy] forKey:defaultsKeyName];
-    [self bind:defaultsKeyName toObject:[NSUserDefaultsController sharedUserDefaultsController]
-        withKeyPath:[@"values." stringByAppendingString:defaultsKeyName] options:_bindingOptions];
+    [self bind:defaultsKeyName
+        toObject:[NSUserDefaultsController sharedUserDefaultsController]
+        withKeyPath:[@"values." stringByAppendingString:defaultsKeyName]
+        options:_bindingOptions];
 }
 
 - (void) breakBindingWithDefaultsKey: (NSString*) defaultsKeyName
@@ -103,6 +109,7 @@
 
     // Just deleting the old shortcut
     if (newShortcut == nil) {
+        [_shortcuts removeObjectForKey:key];
         return;
     }
 

Framework/MASShortcutBinderTests.m

@@ -95,4 +95,13 @@ static NSString *const SampleDefaultsKey = @"sampleShortcut";
         @"Bind shortcut using a default value.");
 }
 
+// See issue #64 <http://git.io/x5YS> for rationale and discussion.
+- (void) testIllegalSymbolsInBindingNames
+{
+    XCTAssertThrows([_binder bindShortcutWithDefaultsKey:@"foo.bar" toAction:^{}],
+        @"Throw for illegal binding symbols: a dot (“.”).");
+    XCTAssertThrows([_binder bindShortcutWithDefaultsKey:@"foo bar" toAction:^{}],
+        @"Throw for illegal binding symbols: a space (“ ”).");
+}
+
 @end

Framework/MASShortcutView.h

@@ -21,4 +21,6 @@ typedef enum {
 /// Returns custom class for drawing control.
 + (Class)shortcutCellClass;
 
+- (void)setAcceptsFirstResponder:(BOOL)value;
+
 @end

Framework/MASShortcutView.m

@@ -3,9 +3,8 @@
 
 NSString *const MASShortcutBinding = @"shortcutValue";
 
-#define HINT_BUTTON_WIDTH 23.0
-#define BUTTON_FONT_SIZE 11.0
-#define SEGMENT_CHROME_WIDTH 6.0
+static const CGFloat MASHintButtonWidth = 23;
+static const CGFloat MASButtonFontSize = 11;
 
 #pragma mark -
 
@@ -13,6 +12,7 @@ NSString *const MASShortcutBinding = @"shortcutValue";
 
 @property (nonatomic, getter = isHinting) BOOL hinting;
 @property (nonatomic, copy) NSString *shortcutPlaceholder;
+@property (nonatomic, assign) BOOL showsDeleteButton;
 
 @end
 
@@ -23,6 +23,7 @@ NSString *const MASShortcutBinding = @"shortcutValue";
     NSInteger _shortcutToolTipTag;
     NSInteger _hintToolTipTag;
     NSTrackingArea *_hintArea;
+	BOOL _acceptsFirstResponder;
 }
 
 #pragma mark -
@@ -54,9 +55,11 @@ NSString *const MASShortcutBinding = @"shortcutValue";
 {
     _shortcutCell = [[[self.class shortcutCellClass] alloc] init];
     _shortcutCell.buttonType = NSPushOnPushOffButton;
-    _shortcutCell.font = [[NSFontManager sharedFontManager] convertFont:_shortcutCell.font toSize:BUTTON_FONT_SIZE];
+    _shortcutCell.font = [[NSFontManager sharedFontManager] convertFont:_shortcutCell.font toSize:MASButtonFontSize];
     _shortcutValidator = [MASShortcutValidator sharedValidator];
     _enabled = YES;
+    _showsDeleteButton = YES;
+	_acceptsFirstResponder = NO;
     [self resetShortcutCellStyle];
 }
 
@@ -122,14 +125,27 @@ NSString *const MASShortcutBinding = @"shortcutValue";
     
     // Only enabled view supports recording
     if (flag && !self.enabled) return;
-    
-    if (_recording != flag) {
-        _recording = flag;
-        self.shortcutPlaceholder = nil;
-        [self resetToolTips];
-        [self activateEventMonitoring:_recording];
-        [self activateResignObserver:_recording];
-        [self setNeedsDisplay:YES];
+
+    // Only care about changes in state
+    if (flag == _recording) return;
+
+    _recording = flag;
+    self.shortcutPlaceholder = nil;
+    [self resetToolTips];
+    [self activateEventMonitoring:_recording];
+    [self activateResignObserver:_recording];
+    [self setNeedsDisplay:YES];
+
+    // Give VoiceOver users feedback on the result. Requires at least 10.9 to run.
+    if (_recording == NO && (&NSAccessibilityPriorityKey != NULL)) {
+        NSString* msg = _shortcutValue ?
+                         NSLocalizedString(@"Shortcut set", @"VoiceOver: Shortcut set") :
+                         NSLocalizedString(@"Shortcut cleared", @"VoiceOver: Shortcut cleared");
+        NSDictionary *announcementInfo = @{
+            NSAccessibilityAnnouncementKey : msg,
+            NSAccessibilityPriorityKey : @(NSAccessibilityPriorityHigh),
+        };
+        NSAccessibilityPostNotificationWithUserInfo(self, NSAccessibilityAnnouncementRequestedNotification, announcementInfo);
     }
 }
 
@@ -138,7 +154,7 @@ NSString *const MASShortcutBinding = @"shortcutValue";
     _shortcutValue = shortcutValue;
     [self resetToolTips];
     [self setNeedsDisplay:YES];
-    [self propagateValue:shortcutValue forBinding:@"shortcutValue"];
+    [self propagateValue:shortcutValue forBinding:MASShortcutBinding];
 
     if (self.shortcutValueChange) {
         self.shortcutValueChange(self);
@@ -188,9 +204,15 @@ NSString *const MASShortcutBinding = @"shortcutValue";
 - (void)drawRect:(CGRect)dirtyRect
 {
     if (self.shortcutValue) {
-        [self drawInRect:self.bounds withTitle:NSStringFromMASKeyCode(self.recording ? kMASShortcutGlyphEscape : kMASShortcutGlyphClear)
-               alignment:NSRightTextAlignment state:NSOffState];
-        
+        NSString *buttonTitle;
+        if (self.recording) {
+            buttonTitle = NSStringFromMASKeyCode(kMASShortcutGlyphEscape);
+        } else if (self.showsDeleteButton) {
+            buttonTitle = NSStringFromMASKeyCode(kMASShortcutGlyphClear);
+        }
+        if (buttonTitle != nil) {
+            [self drawInRect:self.bounds withTitle:buttonTitle alignment:NSRightTextAlignment state:NSOffState];
+        }
         CGRect shortcutRect;
         [self getShortcutRect:&shortcutRect hintRect:NULL];
         NSString *title = (self.recording
@@ -229,11 +251,11 @@ NSString *const MASShortcutBinding = @"shortcutValue";
 - (void)getShortcutRect:(CGRect *)shortcutRectRef hintRect:(CGRect *)hintRectRef
 {
     CGRect shortcutRect, hintRect;
-    CGFloat hintButtonWidth = HINT_BUTTON_WIDTH;
+    CGFloat hintButtonWidth = MASHintButtonWidth;
     switch (self.style) {
         case MASShortcutViewStyleTexturedRect: hintButtonWidth += 2.0; break;
         case MASShortcutViewStyleRounded: hintButtonWidth += 3.0; break;
-        case MASShortcutViewStyleFlat: hintButtonWidth -= 8.0 - (_shortcutCell.font.pointSize - BUTTON_FONT_SIZE); break;
+        case MASShortcutViewStyleFlat: hintButtonWidth -= 8.0 - (_shortcutCell.font.pointSize - MASButtonFontSize); break;
         default: break;
     }
     CGRectDivide(self.bounds, &hintRect, &shortcutRect, hintButtonWidth, CGRectMaxXEdge);
@@ -376,6 +398,11 @@ void *kUserDataHint = &kUserDataHint;
             // Create a shortcut from the event
             MASShortcut *shortcut = [MASShortcut shortcutWithEvent:event];
 
+            // Tab key must pass through.
+            if (shortcut.keyCode == kVK_Tab){
+                return event;
+            }
+
             // If the shortcut is a plain Delete or Backspace, clear the current shortcut and cancel recording
             if (!shortcut.modifierFlags && ((shortcut.keyCode == kVK_Delete) || (shortcut.keyCode == kVK_ForwardDelete))) {
                 weakSelf.shortcutValue = nil;
@@ -464,7 +491,7 @@ void *kUserDataHint = &kUserDataHint;
 #pragma mark Bindings
 
 // http://tomdalling.com/blog/cocoa/implementing-your-own-cocoa-bindings/
--(void) propagateValue:(id)value forBinding:(NSString*)binding;
+-(void) propagateValue:(id)value forBinding:(NSString*)binding
 {
     NSParameterAssert(binding != nil);
 
@@ -508,4 +535,73 @@ void *kUserDataHint = &kUserDataHint;
     [boundObject setValue:value forKeyPath:boundKeyPath];
 }
 
+#pragma mark - Accessibility
+
+- (BOOL)accessibilityIsIgnored
+{
+    return NO;
+}
+
+- (NSString *)accessibilityHelp
+{
+    return NSLocalizedString(@"To record a new shortcut, click this button, and then type the"
+                             @" new shortcut, or press delete to clear an existing shortcut.",
+                             @"VoiceOver shortcut help");
+}
+
+- (NSString *)accessibilityLabel
+{
+    NSString* title = _shortcutValue.description ?: @"Empty";
+    title = [title stringByAppendingFormat:@" %@", NSLocalizedString(@"keyboard shortcut", @"VoiceOver title")];
+    return title;
+}
+
+- (BOOL)accessibilityPerformPress
+{
+    if (self.isRecording == NO) {
+        self.recording = YES;
+        return YES;
+    }
+    else {
+        return NO;
+    }
+}
+
+- (NSString *)accessibilityRole
+{
+    return NSAccessibilityButtonRole;
+}
+
+- (BOOL)acceptsFirstResponder
+{
+	return _acceptsFirstResponder;
+}
+
+- (void)setAcceptsFirstResponder:(BOOL)value
+{
+	_acceptsFirstResponder = value;
+}
+
+- (BOOL)becomeFirstResponder
+{
+    [self setNeedsDisplay:YES];
+    return [super becomeFirstResponder];
+}
+
+- (BOOL)resignFirstResponder
+{
+    [self setNeedsDisplay:YES];
+    return [super resignFirstResponder];
+}
+
+- (void)drawFocusRingMask
+{
+    [_shortcutCell drawFocusRingMaskWithFrame:[self bounds] inView:self];
+}
+
+- (NSRect)focusRingMaskBounds
+{
+    return [self bounds];
+}
+
 @end

MASShortcut.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name                  = 'MASShortcut'
-  s.version               = '2.1.1'
+  s.version               = '2.2.0'
   s.summary               = 'Modern framework for managing global keyboard shortcuts compatible with Mac App Store'
   s.homepage              = 'https://github.com/shpakovski/MASShortcut'
   s.license               = 'BSD 2-clause'
@@ -9,7 +9,7 @@ Pod::Spec.new do |s|
 
   s.platform              = :osx
   s.osx.deployment_target = "10.6"
-  s.source                = { :git => 'https://github.com/shpakovski/MASShortcut.git', :tag => '2.1.1' }
+  s.source                = { :git => 'https://github.com/shpakovski/MASShortcut.git', :tag => '2.2.0' }
   s.source_files          = 'Framework/*.{h,m}'
   s.exclude_files         = 'Framework/*Tests.m'
   s.osx.frameworks        = 'Carbon', 'AppKit'

MASShortcut.xcodeproj/project.pbxproj

@@ -106,6 +106,7 @@
 		0DC2F18F199372B4003A0131 /* MASDictionaryTransformerTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = MASDictionaryTransformerTests.m; path = Framework/MASDictionaryTransformerTests.m; sourceTree = "<group>"; };
 		0DC2F19619938EFA003A0131 /* MASShortcutView+Bindings.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = "MASShortcutView+Bindings.h"; path = "Framework/MASShortcutView+Bindings.h"; sourceTree = "<group>"; };
 		0DC2F19719938EFA003A0131 /* MASShortcutView+Bindings.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = "MASShortcutView+Bindings.m"; path = "Framework/MASShortcutView+Bindings.m"; sourceTree = "<group>"; };
+		EAFFDC811AACFF3300F38834 /* MASShortcut.modulemap */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = "sourcecode.module-map"; name = MASShortcut.modulemap; path = Framework/MASShortcut.modulemap; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
 /* Begin PBXFrameworksBuildPhase section */
@@ -177,6 +178,7 @@
 				0DC2F18A19937060003A0131 /* User Defaults Storage */,
 				0D827DA119912A6D0010B8EF /* UI */,
 				0D827D2F1990D5640010B8EF /* Info.plist */,
+				EAFFDC811AACFF3300F38834 /* MASShortcut.modulemap */,
 				0D827D98199110F60010B8EF /* Prefix.pch */,
 				0D827D761990F81E0010B8EF /* Shortcut.h */,
 			);
@@ -316,9 +318,9 @@
 			productReference = 0D827D371990D5E70010B8EF /* Demo.app */;
 			productType = "com.apple.product-type.application";
 		};
-		0D827D8219910AFF0010B8EF /* Tests */ = {
+		0D827D8219910AFF0010B8EF /* MASShortcutTests */ = {
 			isa = PBXNativeTarget;
-			buildConfigurationList = 0D827D9219910AFF0010B8EF /* Build configuration list for PBXNativeTarget "Tests" */;
+			buildConfigurationList = 0D827D9219910AFF0010B8EF /* Build configuration list for PBXNativeTarget "MASShortcutTests" */;
 			buildPhases = (
 				0D827D7F19910AFF0010B8EF /* Sources */,
 				0D827D8019910AFF0010B8EF /* Frameworks */,
@@ -329,7 +331,7 @@
 			dependencies = (
 				0D827D8F19910AFF0010B8EF /* PBXTargetDependency */,
 			);
-			name = Tests;
+			name = MASShortcutTests;
 			productName = Tests;
 			productReference = 0D827D8319910AFF0010B8EF /* Tests.xctest */;
 			productType = "com.apple.product-type.bundle.unit-test";
@@ -362,8 +364,8 @@
 			projectRoot = "";
 			targets = (
 				0D827CD21990D4420010B8EF /* MASShortcut */,
+				0D827D8219910AFF0010B8EF /* MASShortcutTests */,
 				0D827D361990D5E70010B8EF /* Demo */,
-				0D827D8219910AFF0010B8EF /* Tests */,
 			);
 		};
 /* End PBXProject section */
@@ -517,6 +519,7 @@
 			isa = XCBuildConfiguration;
 			buildSettings = {
 				COMBINE_HIDPI_IMAGES = YES;
+				DEFINES_MODULE = YES;
 				DYLIB_COMPATIBILITY_VERSION = 1;
 				DYLIB_CURRENT_VERSION = 1;
 				FRAMEWORK_VERSION = A;
@@ -525,6 +528,7 @@
 				INFOPLIST_FILE = Framework/Info.plist;
 				INSTALL_PATH = "@executable_path/../Frameworks";
 				MACOSX_DEPLOYMENT_TARGET = 10.6;
+				MODULEMAP_FILE = Framework/MASShortcut.modulemap;
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				SKIP_INSTALL = YES;
 				WRAPPER_EXTENSION = framework;
@@ -535,6 +539,7 @@
 			isa = XCBuildConfiguration;
 			buildSettings = {
 				COMBINE_HIDPI_IMAGES = YES;
+				DEFINES_MODULE = YES;
 				DYLIB_COMPATIBILITY_VERSION = 1;
 				DYLIB_CURRENT_VERSION = 1;
 				FRAMEWORK_VERSION = A;
@@ -543,6 +548,7 @@
 				INFOPLIST_FILE = Framework/Info.plist;
 				INSTALL_PATH = "@executable_path/../Frameworks";
 				MACOSX_DEPLOYMENT_TARGET = 10.6;
+				MODULEMAP_FILE = Framework/MASShortcut.modulemap;
 				PRODUCT_NAME = "$(TARGET_NAME)";
 				SKIP_INSTALL = YES;
 				WRAPPER_EXTENSION = framework;
@@ -647,7 +653,7 @@
 			defaultConfigurationIsVisible = 0;
 			defaultConfigurationName = Release;
 		};
-		0D827D9219910AFF0010B8EF /* Build configuration list for PBXNativeTarget "Tests" */ = {
+		0D827D9219910AFF0010B8EF /* Build configuration list for PBXNativeTarget "MASShortcutTests" */ = {
 			isa = XCConfigurationList;
 			buildConfigurations = (
 				0D827D9019910AFF0010B8EF /* Debug */,

MASShortcut.xcodeproj/xcshareddata/xcschemes/MASShortcut.xcscheme

@@ -29,8 +29,8 @@
             <BuildableReference
                BuildableIdentifier = "primary"
                BlueprintIdentifier = "0D827D8219910AFF0010B8EF"
-               BuildableName = "Tests.xctest"
-               BlueprintName = "Tests"
+               BuildableName = "MASShortcutTests.xctest"
+               BlueprintName = "MASShortcutTests"
                ReferencedContainer = "container:MASShortcut.xcodeproj">
             </BuildableReference>
          </BuildActionEntry>
@@ -47,8 +47,8 @@
             <BuildableReference
                BuildableIdentifier = "primary"
                BlueprintIdentifier = "0D827D8219910AFF0010B8EF"
-               BuildableName = "Tests.xctest"
-               BlueprintName = "Tests"
+               BuildableName = "MASShortcutTests.xctest"
+               BlueprintName = "MASShortcutTests"
                ReferencedContainer = "container:MASShortcut.xcodeproj">
             </BuildableReference>
          </TestableReference>

README.md

@@ -1,10 +1,31 @@
 [![Build Status](https://travis-ci.org/shpakovski/MASShortcut.svg?branch=master)](https://travis-ci.org/shpakovski/MASShortcut)
+[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
 
 # Intro
 
 Some time ago Cocoa developers used a brilliant framework [ShortcutRecorder](http://wafflesoftware.net/shortcut/) for managing keyboard shortcuts in application preferences. However, it became incompatible with the new plugin architecture of Xcode 4.
 
-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.
+The MASShortcut project introduces a modern API and user interface for recording, storing and using system-wide keyboard shortcuts.
+
+![Screenshot of the demo project](/Demo/screenshot.png?raw=true "This is how the demo looks like")
+
+Features:
+
+* Record and display keyboard shortcuts
+* Watch for shortcuts and execute actions, system-wide
+* A nice, [documented API](http://cocoadocs.org/docsets/MASShortcut/)
+* Can be configured to be compatible with Shortcut Recorder
+* Can be installed both through CocoaPods and as a Git submodule
+* Mac App Store friendly
+* Works on OS X 10.6 and up
+* Hacking-friendly codebase covered with tests
+* Basic accessibility support
+
+Important features currently missing:
+
+* Localisation
+
+Pull requests welcome :)
 
 # Installation
 
@@ -16,6 +37,8 @@ If you want to stick to the 1.x branch, you can use the version smart match oper
 
     pod 'MASShortcut', '~> 1'
 
+Or can use Git submodules and link against the MASShortcut framework.
+
 # Usage
 
 I hope, it is really easy:

Spec.md

@@ -12,4 +12,14 @@ Please stay high-level when writing the spec, do not document particular classes
 * If the shortcut is Cmd-W or Cmd-Q, the recording must be cancelled and the keypress passed through to the system, closing the window or quitting the app.
 * If a shortcut is already taken by system and is enabled, it must be rejected. (Examples: Cmd-S, Cmd-N. TBD: What exactly does it mean that the shortcut is “enabled”?)
 * TBD: Option-key handling.
-* All other shortcuts must be accepted. (Examples: Ctrl-Esc, Cmd-Delete, F16.)
+* All other shortcuts must be accepted. (Examples: Ctrl-Esc, Cmd-Delete, F16.)
+
+# Formatting Shortcuts
+
+On different keyboard layouts (such as US and Czech), a single shortcut (a combination of physical keys) may be formatted into different strings.
+
+For example, the default system shortcut for toggling directly to Space #2 is Control–2. But when you switch to the Czech keyboard layout, the physical key with the `2` label now inserts the `ě` character. Thus, on most keyboard layouts the shortcut for toggling to Space #2 is called `^2`, but on the Czech layout it’s called `^ě`. (I stress that this is the same combination of hardware keys and the same `MASShortcut` instance.)
+
+This is reflected by the system: When you open the System Preferences → Keyboard → Shortcuts pane, the shortcuts displayed depend on the currently selected keyboard layout (try switching between the US and Czech keyboard layouts and reopening the preference pane).
+
+This means that the identity of a shortcut is given by its key code and modifiers (such as `kVK_ANSI_2` and `NSControlKeyMask`), not the `keyCodeString` returned by the `MASShortcut` class. This string may change depending on the current keyboard layout: `^2` with the US keyboard active, but `^ě` with the Czech keyboard active.