Added a note about Shortcut Recorder compatibility (#54).

1 files changed, 9 insertions, 0 deletions

diff --git a/README.md b/README.md
index d90bc0f..d753f67 100644
--- a/README.md
+++ b/README.md
@@ -42,6 +42,15 @@ self.shortcutView.associatedUserDefaultsKey = kPreferenceGlobalShortcut;
 
 You can see a real usage example in the Demo target. Enjoy!
 
+# Shortcut Recorder Compatibility
+
+By default, MASShortcut uses a different User Defaults storage format incompatible with Shortcut Recorder. But it’s easily possible to change that, so that you can replace Shortcut Recorder with MASShortcut without having to migrate the shortcuts previously stored by your apps. There are two parts of the story:
+
+1. If you bind the recorder control (`MASShortcutView`) to User defaults, set the Value Transformer field in the Interface Builder to `MASDictionaryTransformer`. This makes sure the shortcuts are written in the Shortcut Recorder format.
+2. If you use `MASShortcutBinder` to automatically load shortcuts from User Defaults, set the `bindingOptions` accordingly:
+        [[MASShortcutBinder sharedBinder] setBindingOptions:@{NSValueTransformerNameBindingOption:MASDictionaryTransformerName}];
+    This makes sure that the shortcuts in the Shortcut Recorder format are loaded correctly.
+
 # Notifications
 
 By registering for KVO notifications from `NSUserDefaultsController`, you can get a callback whenever a user changes the shortcut, allowing you to perform any UI updates, or other code handling tasks.