pushing to cdn and tests changes

rudder-client-javascript/README.md

@@ -1,30 +1,129 @@
 # Rudder JS-SDK
 
+
+
 This repo contains **builds** and **source-code** to integrate with your web-app and node applications. Use this to send analytics data from your applications to ever evolving destinations such as (HubSpot, Google Analytics and many more...)
 
+
+
 # How to get started
 
-Under the **analytics** folder, navigate to **dist** where you can find the minified and unminified versions of the sdk. There are two builds for working with browser based applications and node applications, mainly **browser.js** and **node.js**.
+
+
+Under the **analytics** folder, navigate to **dist** where you can find the minified and unminified versions of the sdk. There are two builds for working with browser based applications and node applications, mainly **browser.js** and **node.js**. There is also a minified **browser.min.js** which is hosted.
+
+Few sample usage of the sdk can be found under **tests** directory for vanilla html, Angular, and node integrations.
+
+**Setup**
+```
+// Script load start for working in browser env
+
+<script  type="text/javascript">
+	analytics = window.analytics = [];
+	var  methods = [
+	"load", 
+	"page", 
+	"track", 
+	"identify", 
+	"trackEvent", 
+	"trackPage",
+	 "identifyUser", 
+	 "reset"];
 
-Few sample usage of the sdk can be found under **tests** directory for vanilla html, Angular, and node integrations. 
+	for(var  i=0;i<methods.length;i++){
+		var  method = methods[i];
+		analytics[method] = function(methodName){
+			return  function(){
+			analytics.push([methodName, ...arguments]);
+			}
+		}(method)
+	}
+	analytics.load("YOUR_WRITE_KEY", "DATA_PLANE_URI");
+	//analytics.load("1S2kNlbkMrWLBO79H2eNuEST27I", "http://localhost:9090");
+</script>
+<script  src="https://unpkg.com/[email protected]"></script>
 
+//The above is basically the browser.min.js being serviced by cdn, for local 
+   testing, one can refer the js under dist folder
+   
+//This marks the end of loading our script, one can wrap the above 
+   in iife if it helps
+
+//  Sample calls on global analytics object, 
+    for more examples, refer the tests folder
+    
+<script  type="text/javascript">
+	analytics.page(
+		"ApplicationLoaded",
+		{
+			path:  "",
+			referrer:  "",
+			search:  "",
+			title:  "",
+			url:  ""
+		},
+		{
+			context: {
+				ip:  "0.0.0.0"
+			},
+			anonymousId:  "00000000000000000000000000"
+		},
+		() => {console.log("in identify");}
+	);
+
+	analytics.track(
+		"test track event GA3",
+		{
+			type:  event,
+			user_actual_role:  'system_admin, system_user' ,
+			user_actual_id:  12345
+		},
+		{
+			context: {
+				ip:  "0.0.0.0"
+			},
+			anonymousId:  "00000000000000000000000000"
+		}
+	);
+</script>
+
+```
 ## Code Structure
 
-- The whole code development is under the **analytics** folder. 
-- **analytics.js** handles the core functionality for tapping your **identify**, **page** and **track** calls.
-- **integrations** contains the native loading and invocation of different destinations. 
-- **HubSpot** and **Google Analytics** integrations have been in development recently. 
+
+
+- The whole code development is under the **analytics** folder.
+
+-  **analytics.js** handles the core functionality for tapping your **identify**, **page** and **track** calls.
+
+-  **integrations** contains the native loading and invocation of different destinations.
+
+-  **HubSpot** and **Google Analytics** integrations have been in development recently.
+
+
 
 ***We try to support both browser and node versions of these integrations. It may so happen that integrations doesn't have a node sdk, in that case routing data through our **data-plane** is one of the options to send data to these destinations*
+
 - The **dist** folder contains the minified and unminified versions of the sdk.
-- **tests** contains various flavours for how to use the sdk in applications
+
+-  **tests** contains various flavours for how to use the sdk in applications
+
 - We use *rollup* and *babel* for transpiling and generating the specific builds.
 
+
+
 ## Contribute
 
+
+
 One can start adding integrations like *Mixpanel*, *Facebook ads* and others for sending data through their *js* and *node* sdks.
 
+
+
 For building the sdk,
 
- - Look for run scripts in the *package.json* file for getting browser and node specific builds.
- - For adding or removing integrations, modify the *imports* in *index.js* under **integrations** folder.
+
+
+- Look for run scripts in the *package.json* file for getting browser and node specific builds.
+
+- For adding or removing integrations, modify the *imports* in *index.js* under **integrations** folder.