Permalink
Browse files

more documentation updates

  • Loading branch information...
robbywalker committed Jan 17, 2013
1 parent 8e3e23b commit 73de0a8f4d89f1f3eab7b7220cf38d8f9b70aed6
Showing with 19 additions and 1 deletion.
  1. +3 −0 HookshotDemo/README.md
  2. +16 −1 README.md
View
@@ -0,0 +1,3 @@
+# hookshot demo
+
+The hookshot demo is a simple application that loads the Cue home page and instruments UIWebView, the AppDelegate, and counts live instances of images.
View
@@ -21,10 +21,25 @@ AppDelegate.application:didFinishLaunchingWithOptions:
...
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-## hookshot uses undocumented Apple APIs
+### hookshot uses undocumented Apple APIs
We'll say it again: **hookshot uses undocumented Apple APIs.** This is necessary for profiling and debugging, but will get your application rejected during App Store review if hookshot makes it in to production code. Follow the installation instructions to ensure hookshot is properly configured to be one big NOOP for release builds.
+## What is it?
+
+hookshot contains an instrumenting profiler. Contrary to its name, Apple's profiler in Instruments is actually a sampling profiler. We find both useful
+for different occasions. Specifically, we find hookshot most useful for:
+
+* Thread activity graphs with drill-in
+
+* Seeing accurate counts of calls
+
+* More precise per-call timings of messages
+
+* Measurement of messages with highly variable performance
+
+hookshot also contains utilities for counting live instances of classes you care about and generic message instrumentation.
+
## Installation
You can get hookshot in your project within about 5 minutes: [step-by-step installation instructions](/Cue/hookshot/blob/master/Documentation/INSTALL.md)

0 comments on commit 73de0a8

Please sign in to comment.