Publicly deprecate.

stephencelis · Mar 4, 2011 · bba3b24 · bba3b24
1 parent 72530fa
commit bba3b24
Showing 1 changed file with 27 additions and 13 deletions.
diff --git a/README.markdown b/README.markdown
@@ -1,3 +1,17 @@
+Please Note! This Library Is Deprecated!
+----------------------------------------
+
+Please don't use this library anymore. It was a good run, though. We had some
+laughs and it was easy for the iPhone to hear them.
+
+This code has been deprecated in favor of Apple's built-in solution, available
+since iOS 3.0:
+[`AVAudioRecorder`](http://developer.apple.com/library/ios/#documentation/AVFoundation/Reference/AVAudioRecorder_ClassReference/Reference/Reference.html).
+
+Mobile Orchard published
+[a nice tutorial](http://mobileorchard.com/tutorial-detecting-when-a-user-blows-into-the-mic/).
+
+
 SCListener 1.0.1
 ================
 
@@ -11,33 +25,33 @@ Usage
 -----
 
     #import "SCListener.h" // Remember to link to AudioToolbox.framework.
-    
+
     // Start listening.
     [[SCListener sharedListener] listen];
-    
+
     // Retrieve the average power.
     [[SCListener sharedListener] averagePower];
-    
+
     // Retrieve the peak power.
     [[SCListener sharedListener] peakPower];
-    
+
     // Hmm...we're using this guy a lot...
     SCListener *listener = [SCListener sharedListener];
-    
+
     // We can temporarily stop returning levels
     [listener pause];
     [listener listen]; // Quick.
-    
+
     // Or free up resources when we're not listening for awhile.
     [listener stop];
     [listener listen]; // Slower.
-    
+
     // Advanced!:
     //
     // If you're using the average and the peak, fetch both at once.
     if (![listener isListening]) // If listener has paused or stopped...
       return;                    // ...bail.
-    
+
     AudioQueueLevelMeterState *levels = [listener levels];
     Float32 peak = levels[0].mPeakPower;
     Float32 average = levels[0].mAveragePower;
@@ -48,11 +62,11 @@ License
 
 (c) 2009-* Stephen Celis, <stephen@stephencelis.com>.
 
-Permission is hereby granted, free of charge, to any person obtaining a copy 
+Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal 
+of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights 
+in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is 
+copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all