Skip to content

Commit

Permalink
docs: add install info to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
andrepolischuk committed Apr 5, 2021
1 parent 49ae49c commit dc9a785
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,13 @@ This is a fork of [MailOnline/mol-video-ad-sdk](https://github.com/MailOnline/mo

To run video ads in the browser there are many alternatives. The most famous one is probably Google's [IMA SDK](https://developers.google.com/interactive-media-ads/docs/sdks/html5/) for HTML5. There are two main cons with that SDK. It only works through DoubleClick and it is a black box very hard to debug and to maintain. This SDK tries to offer an alternative to play video ads that can work with any player in the world and any ad server that supports the VAST specification. And since it is open source you can read the code and debug if you need to.

## DEMO
## Install

```
yarn install @andrepolischuk/video-ad-sdk
```

## Demo

Demo [here!](https://andrepolischuk.github.io/video-ad-sdk/demo/index.html).

Expand All @@ -21,19 +27,19 @@ We use [nvm](https://github.com/nvm-sh/nvm) to decide which of node to use.
So after you clone the repo you just need to run

```
$ nvm use
nvm use
```

to install the supported node version, then run [`yarn`](https://yarnpkg.com/lang/en/docs/cli/#toc-default-command)'s default command

```
$ yarn
yarn
```

to install and build the packages and finally you can run

```
$ yarn test
yarn test
```

to run the tests.
Expand Down

0 comments on commit dc9a785

Please sign in to comment.