Merge branch 'master' of https://github.com/flipkart-incubator/inline-youtube-view

Author: anirudhramanan

README.md

@@ -1,5 +1,73 @@
 # inline-youtube-view
 
-YouTube component for Android, iOS and React
+YouTube component for Android, iOS and React. This is a suite of utility libraries around using YouTube inside your Android, iOS or React Native app.
 
-**Doc will be updated soon**
+# youtube-android
+
+Playing Youtube on Android (specially inline) comes with some challenges :  
+   - YouTube SDK does not work on all devices ( where YouTube services could have been uninstalled)
+   - You cannot run more than one instance of the YouTube view
+   - Playing them inline where in a list you can have more than one videos in a single list. 
+   
+inline-youtube-view for Android checks if the services are available and will fall back gracefully to using WebView in the event they are not. 
+
+YouTubePlayerView : The YouTubePlayerView provided by the YouTube SDK comes with a restriction that the activty hosting this needs to extend from YouTubeBaseActivity. This view removes these restrictions. 
+
+## Demo Gifs
+
+### YouTubePlayer in Activity (Fullscreen Mode)
+
+![YouTube Activity](https://github.com/flipkart-incubator/inline-youtube-view/blob/master/youtube-activity-android.gif)
+
+### YouTubePlayer in Fragment (inline native)
+
+![YouTube Fragment](https://github.com/flipkart-incubator/inline-youtube-view/blob/master/youtube-fragment-android.gif)
+
+## How to use ?
+
+Add it in your root build.gradle at the end of repositories :
+
+````java
+allprojects {
+   repositories {
+     ...
+     maven { url "https://jitpack.io" }
+   }
+}
+````
+
+Add the dependency
+
+````java
+dependencies {
+   //to be updated soon.
+}
+````
+
+### YouTubePlayer Activity
+
+Start an YouTubeActivity intent with apiKey and videoId. This will play the youtube video in a new activity in fullscreen mode.
+
+````java
+Intent intent = new Intent(MainActivity.this, YouTubeActivity.class);
+intent.putExtra("apiKey", Constants.API_KEY);
+intent.putExtra("videoId", "3AtDnEC4zak");
+startActivity(intent);
+````
+
+### YouTubePlayer Inline
+
+Create an instance of YouTubePlayerView inside a fragment. To initialize the player, you need to call the initPlayer method with following params:
+1. apiKey
+2. videoId
+3. webviewUrl : the link to iframe.html file (this is required when the device is not able to render native video, a fallback). By default, use 'https://cdn.rawgit.com/flipkart-incubator/inline-youtube-view/60bae1a1/youtube-android/youtube_iframe_player.html'
+4. playerType : native, webview or auto (try native, else fallback to webview)
+5. listener : callback listener
+6. fragment : fragment hosting this view
+7. imageLoader : to load thumbnail image
+
+````java
+YouTubePlayerView playerView = new YouTubePlayerView(context);
+playerView.initPlayer(Constants.API_KEY, videoId, "https://cdn.rawgit.com/flipkart-incubator/inline-youtube-view/60bae1a1/youtube-android/youtube_iframe_player.html", playerType, listener, fragment, imageLoader);
+
+````