Просмотр исходного кода

Add simulator shortcut info to README

Ryan Olson лет назад: 10
Родитель
Сommit
e199b529c8
1 измененных файлов с 9 добавлено и 0 удалено
  1. 9 0
      README.md

+ 9 - 0
README.md

@@ -17,6 +17,7 @@ FLEX (Flipboard Explorer) is a set of in-app debugging and exploration tools for
 - Dynamically modify many properties and ivars.
 - Dynamically call instance and class methods.
 - Observe detailed network request history with timing, headers, and full responses.
+- Add your own simulator keyboard shortcuts.
 - View system log messages (e.g. from `NSLog`).
 - Access any live object via a scan of the heap.
 - View the file system within your app's sandbox.
@@ -28,6 +29,9 @@ Unlike many other debugging tools, FLEX runs entirely inside your app, so you do
 
 
 ## Usage
+
+In the iOS simulator, you can use keyboard shortcuts to activate FLEX. `f` will toggle the FLEX toolbar. Hit the `?` key for a full list of shortcuts. You can also show FLEX programatically:
+
 Short version:
 
 ```objc
@@ -71,6 +75,11 @@ FLEX queries malloc for all the live allocated memory blocks and searches for on
 
 ![Heap Exploration](http://engineering.flipboard.com/assets/flex/heap-browser.gif)
 
+### Simulator Keyboard Shortcuts
+Default keyboard shortcuts allow you to activate the FLEX tools, scroll with the arrow keys, and close modals using the escape key. You can also add custom keyboard shortcuts via `-[FLEXMananger registerSimulatorShortcutWithKey:modifiers:action:description]`
+
+![Simulator Shortcuts](https://cloud.githubusercontent.com/assets/1422245/10002927/1106fd32-6067-11e5-8e21-57a357c259b6.png)
+
 ### File Browser
 View the file system within your app's sandbox. FLEX shows file sizes, image previews, and pretty prints `.json` and `.plist` files. You can copy text and image files to the pasteboard if you want to inspect them outside of your app.