Merge pull request #11 from Novage/docs/improvements

Docs: improve docs

Author: mrlika

README.md

@@ -78,6 +78,8 @@ Make sure to reference this file in the `<application>` tag of your **`AndroidMa
 
 ## Usage
 
+#### ⚠️ P2P (WebRTC) may not connect to the outer world if it runs on Android emulators due to its virtual machine [network configuration](https://developer.android.com/studio/run/emulator-networking) (NAT). Please test P2P connectivity on real devices. ⚠️
+
 Once you've completed the setup, P2P Media Loader is ready to use in your application!
 
 ### Kotlin Example
@@ -89,6 +91,7 @@ class MainActivity : ComponentActivity() {
         private const val MANIFEST_URL = "https://test-streams.mux.dev/x36xhzz/x36xhzz.m3u8"
 
         // JSON configuration for P2P Media Loader
+        // See https://novage.github.io/p2p-media-loader/docs/v2.1.0/types/p2p_media_loader_core.CoreConfig.html
         private const val CORE_CONFIG_JSON = "{\"swarmId\":\"TEST_KOTLIN\"}"
 
         // Port on which the P2P server will run
@@ -181,12 +184,14 @@ class MainActivity : ComponentActivity() {
     override fun onStop() {
         super.onStop()
         // Disable P2P features when the activity stops
+        // See https://novage.github.io/p2p-media-loader/docs/v2.1.0/types/p2p_media_loader_core.DynamicCoreConfig.html
         p2pml.applyDynamicConfig("{\"isP2PDisabled\": true}")
     }
 
     override fun onRestart() {
         super.onRestart()
         // Re-enable P2P features when the activity restarts
+        // See https://novage.github.io/p2p-media-loader/docs/v2.1.0/types/p2p_media_loader_core.DynamicCoreConfig.html
         p2pml.applyDynamicConfig("{\"isP2PDisabled\": false}")
     }
 
@@ -210,6 +215,7 @@ public class MainActivity extends AppCompatActivity {
     private static final int SERVER_PORT = 8081;
 
     // JSON configuration for P2P Media Loader
+    // See https://novage.github.io/p2p-media-loader/docs/v2.1.0/types/p2p_media_loader_core.CoreConfig.html
     private static final String CORE_CONFIG_JSON = "{\"swarmId\":\"TEST_KOTLIN\"}";
 
     private ExoPlayer exoPlayer;
@@ -317,6 +323,7 @@ public class MainActivity extends AppCompatActivity {
         super.onRestart();
         // Disable P2P features when the activity stops
         if (p2pml != null) {
+            // See https://novage.github.io/p2p-media-loader/docs/v2.1.0/types/p2p_media_loader_core.DynamicCoreConfig.html
             p2pml.applyDynamicConfig("{ \"isP2PDisabled\": false }");
         }
     }
@@ -326,6 +333,7 @@ public class MainActivity extends AppCompatActivity {
         super.onStop();
         // Re-enable P2P features when the activity restarts
         if (p2pml != null) {
+            // See https://novage.github.io/p2p-media-loader/docs/v2.1.0/types/p2p_media_loader_core.DynamicCoreConfig.html
             p2pml.applyDynamicConfig("{ \"isP2PDisabled\": true }");
         }
     }