Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #8

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,25 +1,26 @@
#mraid-extension
# mraid-extension
Enable viewing of [MRAID](http://www.iab.net/mraid) creatives in a desktop browser.

There are two components, a polyfill that creates the window.mraid object and a browser extension that intercepts any request for mraid.js files and redirects the request to the polyfill.

#Installation
# Installation
The extension is available for download from the chrome store [here](https://chrome.google.com/webstore/detail/appnexus-mraid-viewer/kljmljefjfkglealiaheaapimodndfno).

#Running the extension locally
`````````
# Running the extension locally
```
npm install
npm start
`````````
```

After starting the app, you will be serving mraid.js from localhost:9000/mraid.js. You can also load the local version of the chrome extension by opening chrome://extensions, click the 'Developer Mode' checkbox, click 'Load upacked extension' button and select the dist/chrome folder. At this point, your browser will redirect all requests for any mraid.js file to localhost:9000/mraid.js.

##Editing the local files
## Editing the local files
After running npm start, any changes under the src/polyfill/ directory will be picked up automatically, but changes under src/extension/ will require reloading the extension from the chrome://extensions page.

Building a release version
--------------------------
`````````
```
npm install
./build.sh
`````````
```
Release version will be located in the dist/ directory. The dist/chrome\_release.zip can be uploaded the chrome store.