Skip to content

Commit

Permalink
version and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mikestecker committed Feb 20, 2018
1 parent c164672 commit 7b43448
Show file tree
Hide file tree
Showing 4 changed files with 2,840 additions and 6 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/).

## 1.0.5 - 2018-02-19
### Added
- Added new `embed` variable
### Changed
- Added new parameters to pass along with the `getEmbedUrl` variable
- Updated thumbnail function to simplify after adding the [Embed](https://github.com/oscarotero/Embed) library

## 1.0.4 - 2018-01-29
### Changed
- Updated path and repo name to fit within new recommended guidelines [as discussed here](https://craftcms.stackexchange.com/questions/23535/craft-3-plugin-backwards-compatibility-and-maintenance-for-2-x).
Expand Down
43 changes: 38 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Video Embedder plugin for Craft CMS 3.x

Craft plugin to generate an embed URL from a YouTube or Vimeo URL.
Craft plugin to generate an embed URL from a YouTube or Vimeo URL. This plugin will be 100% free.

Ported over from [Viget's](https://viget.com) [Video Embed plugin for Craft 2.x](https://github.com/vigetlabs/craft-videoembed).

Expand Down Expand Up @@ -41,6 +41,18 @@ Pass a YouTube or Vimeo URL to the `getEmbedUrl` variable and an embed URL will
<iframe src="//www.youtube.com/embed/6xWpo5Dn254"></iframe>
```

___

***New in 1.0.5:***

`getEmbedUrl` will now accept optional parameters to YouTube and Vimeo URL's such as `autoplay`, `rel`, etc:

```
{{ craft.videoEmbedder.getEmbedUrl('https://www.youtube.com/watch?v=6xWpo5Dn254', {autoplay: 1, rel: 0, theme: 'dark'}) }}
```

___

Video Embedder will also pull the largest thumbnail URL from YouTube or Vimeo using the `getVideoThumbnail` variable.

```
Expand All @@ -53,14 +65,35 @@ Video Embedder will also pull the largest thumbnail URL from YouTube or Vimeo us
//img.youtube.com/vi/6xWpo5Dn254/0.jpg
```

___

***New in 1.0.5:***

Video Embedder will now generate the iframe code. Simple use the `embed` variable with your URL. You can also pass in optional parameters to YouTube and Vimeo URL's such as `autoplay`, `rel`, etc.

Basic example:
```
{{ craft.videoEmbedder.embed('https://www.youtube.com/watch?v=6xWpo5Dn254') }}
```

With parameters:
```
{{ craft.videoEmbedder.embed('https://www.youtube.com/watch?v=6xWpo5Dn254', {autoplay: 1, rel: 0, theme: 'dark'}) }}
```

These parameters will simply output at the end of the embed URL string and have only been tested with YouTube and Vimeo. Check with each provider for which parameters are supported.


## Video Embedder Roadmap

Some things to do, and ideas for potential features:

* Add in the ability to actually generate the iframe HTML
* Add new Video URL field type that only allows for supported video URL's
* Add support for more video providers
* Add more thumbnail size options
- [x] Add in the ability to actually generate the iframe HTML
- [ ] Add new Video URL field type that only allows for supported video URL's
- [ ] Add support for more video providers (partially added with 1.0.5 by switching to using the [Embed](https://github.com/oscarotero/Embed) library)
- [ ] Add more thumbnail size options
- [ ] Testing

This is my first plugin and I'm not very experienced with plugin development. Feel free to fork away, add whatever you'd like to see and send me a pull request.

Brought to you by [Mike Stecker](http://github.com/mikestecker)
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "mikestecker/craft-videoembedder",
"description": "Craft plugin to generate an embed URL from a YouTube or Vimeo URL.",
"type": "craft-plugin",
"version": "1.0.4",
"version": "1.0.5",
"keywords": [
"craft",
"cms",
Expand Down
Loading

0 comments on commit 7b43448

Please sign in to comment.