aboutsummaryrefslogtreecommitdiffstats
path: root/readme.md
diff options
context:
space:
mode:
authorSam Potts <me@sampotts.me>2015-08-08 14:37:12 +1000
committerSam Potts <me@sampotts.me>2015-08-08 14:37:12 +1000
commit38a206892b4869782cd0391307c7610cfe580286 (patch)
tree06ebcc158057649f4b90163444f42bd455baf9bb /readme.md
parent12a737a49e42b8bdeb45004b2fc95842a44030c4 (diff)
downloadplyr-38a206892b4869782cd0391307c7610cfe580286.tar.lz
plyr-38a206892b4869782cd0391307c7610cfe580286.tar.xz
plyr-38a206892b4869782cd0391307c7610cfe580286.zip
YouTube, Captions and Control improvements
- Controls improvements (Fixes #103) - YouTube bug fixes (Fixes #105) - Internationalization support (Fixes #101) - Captions legibility improvements
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md14
1 files changed, 10 insertions, 4 deletions
diff --git a/readme.md b/readme.md
index 23f5a826..506b2f08 100644
--- a/readme.md
+++ b/readme.md
@@ -39,7 +39,7 @@ If you have any cool ideas or features, please let me know by [creating an issue
Check `docs/index.html` and `docs/dist/docs.js` for an example setup.
-**Heads up**, the example `index.html` file needs to be served from a webserver (such as Apache, Nginx, IIS or similar) unless you change the file sources to include http or https. e.g. change `//cdn.plyr.io/1.2.6/plyr.js` to `https://cdn.plyr.io/1.2.6/plyr.js`
+**Heads up**, the example `index.html` file needs to be served from a webserver (such as Apache, Nginx, IIS or similar) unless you change the file sources to include http or https. e.g. change `//cdn.plyr.io/1.3.0/plyr.js` to `https://cdn.plyr.io/1.3.0/plyr.js`
### Bower
If bower is your thang, you can grab Plyr using:
@@ -59,11 +59,11 @@ More info is on [npm](https://www.npmjs.com/package/ember-cli-plyr) and [GitHub]
If you want to use our CDN, you can use the following:
```html
-<link rel="stylesheet" href="https://cdn.plyr.io/1.2.6/plyr.css">
-<script src="https://cdn.plyr.io/1.2.6/plyr.js"></script>
+<link rel="stylesheet" href="https://cdn.plyr.io/1.3.0/plyr.css">
+<script src="https://cdn.plyr.io/1.3.0/plyr.js"></script>
```
-You can also access the `sprite.svg` file at `https://cdn.plyr.io/1.2.6/sprite.svg`.
+You can also access the `sprite.svg` file at `https://cdn.plyr.io/1.3.0/sprite.svg`.
### CSS
If you want to use the default css, add the `plyr.css` file from /dist into your head, or even better use `plyr.less` or `plyr.sass` file included in `/src` in your build to save a request.
@@ -183,6 +183,12 @@ You can pass the following options to the setup method using `plyr.setup({...})`
<td>Toggle which control elements you would like to display when using the default controls html. If you specify a <code>html</code> option, this is redundant. The default value is to display everything.</td>
</tr>
<tr>
+ <td><code>i18n</code></td>
+ <td>Object</td>
+ <td><code><a href="controls.md">See controls.md</a></code></td>
+ <td>Used for internationalisation (i18n) of the tooltips/labels within the buttons.</td>
+ </tr>
+ <tr>
<td><code>iconPrefix</code></td>
<td>String</td>
<td><code>icon</code></td>