Skip to content

Commit 877e165

Browse files
committed
Formatting changes to readme
1 parent 4ac0ec3 commit 877e165

File tree

1 file changed

+32
-24
lines changed

1 file changed

+32
-24
lines changed

README.md

+32-24
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,58 @@
1-
# MRAID WebTester, a certified MRAID v2 container
2-
3-
MRAID WebTester is a community-driven tool to run MRAID ad units in a web environment. This provides a way to confirm that you are using the MRAID design specification correctly even if you don't have an SDK or app.
4-
5-
## Using the tool
1+
## MRAID WebTester: A Certified MRAID v2 Container
2+
MRAID WebTester is a community-driven tool to run MRAID ad units in a web environment. This provides a way to confirm that you are using the MRAID design specification correctly even if you don't have an SDK or app. It passes the compliance ad test provided by the IAB.
63

4+
### Using the tool
75
The easiest way to use the tool is to navigate to http://webtester.mraid.org/. This site represents the master branch and you don't need to download any additional files.
86

7+
===
98
PREPARE: One the first screen, provide the properties for your test environment
10-
* Geometry: These are the measurements for your default ad size, maximum ad size, and screen size. You can update these values either by dragging and resizing the preview boxes, or by entering values into the form.
11-
* API version: You may select between either version 1 of the API or version 2. Most SDKs are Version 2.
12-
* Placement: You may choose between Inline or Interstitial placement as defined by the MRAID specification.
13-
* Off-Screen: When you choose "Off-Screen", the tester provides pages and navigation to slide your ad into view
14-
* Native features to emulate: Choose the features that best mirror the type of device you are developing for
15-
* Click "Next" or the Flight tab when ready to continue
169

10+
* Geometry: These are the measurements for your default ad size, maximum ad size, and screen size. You can update these values either by dragging and resizing the preview boxes, or by entering values into the form.
11+
* API version: You may select between either version 1 of the API or version 2. Most SDKs are Version 2.
12+
* Placement: You may choose between Inline or Interstitial placement as defined by the MRAID specification.
13+
* Off-Screen: When you choose "Off-Screen", the tester provides pages and navigation to slide your ad into view
14+
* Native features to emulate: Choose the features that best mirror the type of device you are developing for
15+
* Click "Next" or the Flight tab when ready to continue
16+
17+
===
1718
FLIGHT: On the second screen, provide the ad tag
18-
* Tag Source: This is the text box for your HTML tag. This should be HTML and not a URL.
19-
* Click "Render" to continue
2019

20+
* Tag Source: This is the text box for your HTML tag. This should be HTML and not a URL.
21+
* Click "Render" to continue
22+
23+
===
2124
TEST: The last screen allows you to see the MRAID interactions in your ad unit
22-
* A pop-up attempts to display your ad unit in a web-based MRAID container
23-
* Console: Output from the container is logged to this text area in reverse-chronological order...use Error, Info, and Clear to limit the output to the screen.
24-
* Controls: A landscape control button allows you to simulate device orientation changes...click on the clock icon to toggle this control on a regular timing.
2525

26+
* A pop-up attempts to display your ad unit in a web-based MRAID container
27+
* Console: Output from the container is logged to this text area in reverse-chronological order...use Error, Info, and Clear to limit the output to the screen.
28+
* Controls: A landscape control button allows you to simulate device orientation changes...click on the clock icon to toggle this control on a regular timing.
29+
30+
===
2631
You can then use web developer tools to see additional console logging on the pop-up container.
2732

2833

29-
## Integrating with the Online WebTester
34+
### Integrating with the Online WebTester
3035

31-
The online web tester provides one integration point: the querystring variable "adtag". Use this as a key-value pair for injecting your HTML into the Flight tab. For example, to inject an HTML tag like this <h1>hello world</h1> into the web tester when you start it, add an adtag query string with URL encoding like this:
32-
http://webtester.mraid.org/index.html?adtag=%3Ch1%3Ehello%20world%3C%2Fh1%3E
36+
The online web tester provides one integration point: the querystring variable "adtag". Use this as a key-value pair for injecting your HTML into the Flight tab. For example, to inject an HTML tag like this
37+
```<h1>hello world</h1>```
38+
into the web tester when you start it, add an adtag query string with URL encoding like this:
39+
40+
http://webtester.mraid.org/index.html?adtag=%3Ch1%3Ehello%20world%3C%2Fh1%3E
3341

3442

35-
## MRAID compliance ads
43+
### MRAID compliance ads
3644

3745
The MRAID Version 2 API requires that any certified container must run the compliance ads developed by the IAB. These ad units are included in this project for your convenience.
3846

3947

40-
## Reporting a bug
48+
### Reporting a bug
4149

4250
To report a bug simply create a new GitHub Issue and describe your problem or suggestion. However, you may want to join the MRAID WebTester forum to get some input from the coders supporting this project. https://groups.google.com/forum/#!forum/mraid-web-tester
4351

44-
## License
52+
### License
4553

4654
The MRAID WebTester is distributed under the BSD License.
4755

48-
## Thank you!
56+
### Thank you!
4957

50-
We really appreciate all kind of feedback and contributions. Thanks for using and supporting MRAID WebTester!
58+
We really appreciate all kind of feedback and contributions. Thanks for using and supporting MRAID WebTester!

0 commit comments

Comments
 (0)