Skip to content

Update the README to reflect correct usage of the script #88

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

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

Update the README to reflect correct usage of the script #88

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
16 changes: 6 additions & 10 deletions modules/stub/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,27 +10,23 @@ npm install @iabgpp/stub

#### Using

##### include via module loading
##### Include via module loading

```javascript
import * as cmpstub from "@iabgpp/stub";
import "@iabgpp/stub";
```

or

```javascript
const cmpstub = require("@iabgpp/stub");
require("@iabgpp/stub");
```

then execute:
This will set up the global `__gpp()` window function with the queuing functionality. **You do not need to call any function after import; `__gpp` is available globally.**

```javascript
cmpstub();
```

this should generate the `__gpp()` window function with the queing functionality.
> **Note:** Importing or requiring this module has a global side effect: it attaches `__gpp` to the `window` object.

##### to drop on a page
##### To drop on a page

```
git clone https://github.com/InteractiveAdvertisingBureau/iabgpp-es.git
Expand Down