Update jquery-before-ready.js

aim12340 · web-flow · commit a4f7cdc38a5f · 2017-04-19T11:50:22.000+01:00
diff --git a/jquery-before-ready.js b/jquery-before-ready.js
@@ -1,10 +1,34 @@
-// Load this script immediatley after jQuery, or as as early as possible.
-// Then use .beforeReady instead of .ready(), e.g.
-//
-//  $.beforeReady(function() {
-//    alert("Ere I am JH")
-//  });
-//
+/*
+Load this script immediatley after jQuery, or as as early as possible.
+Then use .beforeReady to execute code before any .ready() functions, e.g.
+
+$.beforeReady(function() {
+  alert("Ere I am JH")
+});
+
+
+Here is an example html file showing how the .beforeReady() function executes before the .ready() function.
+<html>
+    <head>
+        <script src="https://code.jquery.com/jquery-3.2.1.min.js"></script>
+        <script src="jquery-before-ready.js"></script>
+    </head>
+    <body>
+        <script>
+            $(document).ready({
+                alert("This function is declared first!")
+            })
+        </script>
+        <script>
+            $.beforeReady(function(){
+                alert("This function is declared second but executes first!")
+            })
+        </script>        
+    </body>
+</html>
+*/
+
+
 
 jQuery.beforeReadyPrivateArray = []
 jQuery.beforeReady = function (handler) {
