Browsi RTD provider docs

modules/browsiRtdProvider.md

@@ -0,0 +1,55 @@
+# Overview
+
+The Browsi RTD module provides viewability predictions for ad slots on the page.
+To use this module, you’ll need to work with [Browsi](https://gobrowsi.com/) to get an account and receive instructions on how to set up your pages and ad server.
+
+# Configurations
+
+Compile the Browsi RTD Provider into your Prebid build:
+
+`gulp build --modules=browsiRtdProvider`
+
+
+Configuration example for using RTD module with `browsi` provider
+```javascript
+    pbjs.setConfig({
+        "realTimeData": {
+            "auctionDelay": 1000,
+            dataProviders:[{
+                "name": "browsi",
+                "waitForIt": "true"
+                "params": {
+                    "url": "testUrl.com",
+                    "siteKey": "testKey",
+                    "pubKey": "testPub",
+                    "keyName":"bv"
+                }  
+            }]
+        }
+    });
+```  
+
+#Params
+
+Contact Browsi to get required params
+
+|  param name | type  |Scope | Description |
+| :------------ | :------------ | :------- | :------- |
+| url  | string  | required | Browsi server URL |
+| siteKey  | string  | required | Site key |
+| pubKey  | string  | required | Publisher key |
+| keyName  | string  | optional | Ad unit targeting key |
+
+
+#Output
+`getTargetingData` function will return expected viewability prediction in the following structure:
+```json
+{
+  "adUnitCode":{
+      "browsiViewability":"0.6"
+  },
+  "adUnitCode2":{
+      "browsiViewability":"0.9"
+  }
+}
+``` 

modules/rtdModule/provider.md

@@ -1,27 +1,33 @@
 New provider must include the following:
 
-1. sub module object:
-```
-export const subModuleName = {
-  name: String,
-  getData: Function <Promise>
-};
-```
+1. sub module object with the following keys:
 
-2. Function that returns the real time data according to the following structure:
-```
+|  param name | type  | Scope | Description | Params |
+| :------------ | :------------ | :------ | :------ | :------ |
+| name  | string  | required | must match the name provided by the publisher in the on-page config | n/a |
+|  init | function | required | defines the function that does any auction-level initialization required | config, userConsent |
+|  getTargetingData  | function | optional | defines a function that provides ad server targeting data to RTD-core | adUnitArray, config, userConsent |
+|  getBidRequestData  | function | optional | defines a function that provides ad server targeting data to RTD-core | reqBidsConfigObj, callback, config, userConsent  |
+|  onAuctionInitEvent | function | optional | listens to the AUCTION_INIT event and calls a sub-module function that lets it inspect and/or update the auction | auctionDetails, config, userConsent |
+|  onAuctionEndEvent | function |optional | listens to the AUCTION_END event and calls a sub-module function that lets it know when auction is done | auctionDetails, config, userConsent |
+|  onBidResponseEvent | function |optional | listens to the BID_RESPONSE event and calls a sub-module function that lets it know when a bid response has been collected | bidResponse, config, userConsent |
+
+2. `getTargetingData` function (if defined) should return ad unit targeting data according to the following structure:
+```json
 {
   "adUnitCode":{
       "key":"value",
       "key2":"value"
   },
   "adUnitCode2":{
-      "dataKey":"dataValue",
+      "dataKey":"dataValue"
   }
 }
 ``` 
 
 3. Hook to Real Time Data module:
-```
+```javascript
 submodule('realTimeData', subModuleName);
 ```
+
+4. See detailed documentation [here](https://docs.prebid.org/dev-docs/add-rtd-submodule.html)