Skip to content

Commit b925b6a

Browse files
author
Neal Malkani
committed
updated readme
1 parent 8a72836 commit b925b6a

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

Diff for: README.md

+8-6
Original file line numberDiff line numberDiff line change
@@ -434,21 +434,23 @@ NOTE: Prebid is supported for SRA. Amazon A9/TAM is not supported for SRA and w
434434
NOTE: ArcAds SRA implementation calls enableSingleRequest() which means that when using pubads lazyLoad functions together with SRA, when the first ad slot comes within the viewport specified by the fetchMarginPercent parameter, the call for that ad and all other ad slots is made. If different behavior is desired after the initial SRA call is made, an outside lazy loading library may be used to manage the calls for regsterAd, reserveAd and other calls.
435435
436436
## Developer Tools
437-
There's a series developer tools available, to get started run `yarn install`.
437+
There's a series developer tools available, to get started run `npm install`.
438438
439439
| Command | Description |
440440
| ------------- | ------------- |
441-
| `yarn dev` | Runs the development command, watches for changes and compiles the changes down to the `dist` directory. |
442-
| `yarn build` | Builds the project into the `dist` directory with minification. |
443-
| `yarn docs` | Generates ESDoc documentation in the `docs` directory on-demand. |
444-
| `yarn test` | Runs a series of unit tests with Jest. Tests are automatically validated during a pull request. |
445-
| `yarn debug` | Starts a local http server so you can link directly to the script during development. For example `<script src="http://localhost:9000/dist/arcads.js"></script> |
441+
| `npm run dev` | Runs the development command, watches for changes and compiles the changes down to the `dist` directory. |
442+
| `npm run build` | Builds the project into the `dist` directory with minification. |
443+
| `npm run docs` | Generates ESDoc documentation in the `docs` directory on-demand. |
444+
| `npm run test` | Runs a series of unit tests with Jest. Tests are automatically validated during a pull request. |
445+
| `npm run debug` | Starts a local http server so you can link directly to the script during development. For example `<script src="http://localhost:9000/dist/arcads.js"></script> |
446446

447447
### Slot Override
448448
You can override the slot name of every advertisement on the page by appending `?adslot=` to the URL. This will override whatever is placed inside of the `slotName` field when invoking the `registerAd` method. For example, if you hit the URL `arcpublishing.com/?adslot=homepage/myad`, the full ad slot path will end up being your DFP id followed by the value: `123/homepage/myad`.
449449

450450
You can also debug slot names and GPT in general by typing `window.googletag.openConsole()` into the browsers developer console.
451451

452+
### Logging
453+
To inspect the funtion calls taking place within the ArcAds library, you can include the `debug=true` query parameter on your page.
452454

453455
## Contributing
454456
If you'd like to contribute to ArcAds please read our [contributing guide](https://github.com/washingtonpost/ArcAds/blob/master/CONTRIBUTING.md).

0 commit comments

Comments
 (0)