Skip to content

Commit

Permalink
Merge branch 'develop'
Browse files Browse the repository at this point in the history
  • Loading branch information
OriginalEXE committed Nov 4, 2016
2 parents 82ef0a9 + b4757b3 commit f9101db
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@

It supports all modern browsers, as well as IE9+. It's worth noting that a lot of mobile devices and tablets do not allow for automatic playback of videos (or their playback in the background), and since there is no universal and easy way to detect that, it's left up to you to figure it out. In the docs, I provide a more detailed description and explain what I used in the demo.

[Demo](https://originalexe.github.io/vidim)
[Demo](https://originalexe.github.io/vidim/)

## What providers are supported
The library right now supports self hosted videos, as well as YouTube. Vimeo is not planned as it's not possible to elegantly hide the UI of their free player, and PRO users have an option of getting the video source directly anyway so they can still use this library with the self hosted provider.

## How to get started?
`npm install vidim`

I would also suggest [reading the docs](https://originalexe.github.io/vidim#docs)
I would also suggest [reading the docs](https://originalexe.github.io/vidim/#docs)

## How to contribute
Clone the repo, run
Expand Down
5 changes: 4 additions & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ <h1>Wellcome to vidi</h1>
<div class="container">
<div class="grid">
<div class="grid__cell grid__cell--100">
<a href="#docs">skip to the docs</a>
<a href="#docs">skip to the docs</a> | <a href="https://github.com/OriginalEXE/vidim">GitHub</a>
<h2>Why do we need another library?</h2>
<p>
While there are a couple of libraries out there, I was not very
Expand Down Expand Up @@ -167,6 +167,9 @@ <h2>Documentation</h2>

<h3>Include the library before your own javascript:</h3>
<pre><code>&lt;script type=&quot;text/javascript&quot; src=&quot;js/vidim.min.js&quot;&gt;&lt;/script&gt;</code></pre>
<p class="description">
You can download the latest stable version from <a href="https://github.com/OriginalEXE/vidim/tree/master/dist">here</a>
</p>

<p>or event better, npm install it:</p>
<pre><code>npm install vidim --save</code></pre>
Expand Down

0 comments on commit f9101db

Please sign in to comment.