Update README.md

README.md

@@ -1,4 +1,134 @@
+<img src="https://dl.dropboxusercontent.com/u/11819370/ksaudioheader.png">
+
 APAudioPlayer
 =============
 
 Drop-in iOS Audio Player built on top of BASS-library. 
+
+
+###Supported formats:
+
+*.m4a,
+*.mp3,
+*.mp2, 
+*.mp1,
+*.wave,
+*.ogg,
+*.wav, 
+*.aiff,
+*.opus,
+*.flac,
+*.wv.
+... and even more I haven't tested.
+
+###Dead-simple interface:
+
+
+Play:
+
+```objc
+- (BOOL)playItemWithURL:(NSURL *)url;
+```
+
+Pause:
+
+```objc
+- (void)pause;
+```
+
+Resume:
+
+```objc
+- (void)resume;
+```
+
+Is playing?:
+
+```objc
+- (BOOL)isPlaying;
+```
+
+Get current track duration:
+
+```objc
+- (NSTimeInterval)duration;
+```
+
+Get current track position:
+
+```objc
+- (NSTimeInterval)position;
+```
+
+Get and set volume:
+
+```objc
+//0..1
+@property (nonatomic, assign) CGFloat volume;
+```
+
+###Dead-simple protocol:
+
+```objc
+/*
+ Will be called when track is over
+ */
+
+- (void)playerDidFinishPlaying:(KSAudioPlayer *)player;
+
+/*
+ Will be called when interruption occured.
+ For ex. phone call.
+ Basically you should call - (void)pause in this case.
+ */
+
+- (void)playerBeginInterruption:(KSAudioPlayer *)player;
+
+/*
+ Will be called when interruption ended.
+ For ex. phone call ended.
+ It's up to you to decide to call - (void)resume or not.
+ */
+
+- (void)playerEndInterruption:(KSAudioPlayer *)player shouldResume:(BOOL)should;
+
+```
+
+
+###Integration:
+
+Cocoapods:
+```ruby
+pod 'KSAudioPlayer'
+```
+
+Manually:
+
+1. Drag-and-drop KSAudioPlaeyr folder into your project.
+2. Add AVFoundation.framework to your project
+3. Instantiate KSAudioPlayer and have fun:
+
+```objc
+//Somewhere during init
+self.player = [KSAudioPlayer new];
+
+//Somewhere else
+NSURL *fileURL = [[NSBundle mainBundle] URLForResource:@"Meat Loaf - Dead Ringer" withExtension:@"wv"];
+[self.player playItemWithURL:fileURL];
+```
+
+###BASS:
+
+BASS is an audio library for use in software on several platforms. Its purpose is to provide developers with powerful and efficient sample, stream (MP3, MP2, MP1, OGG, WAV, AIFF, custom generated, and more via OS codecs and add-ons), MOD music (XM, IT, S3M, MOD, MTM, UMX), MO3 music (MP3/OGG compressed MODs), and recording functions. All in a compact DLL that won't bloat your distribution.
+
+http://www.un4seen.com
+
+http://www.un4seen.com/bass.html#license
+
+###What's next?:
+
+1. Seek to time.
+2. Online streaming.
+
+
+Feel free to open issues and pull requests. Or email me [email protected]