diff --git a/README.md b/README.md index 6afa1a8..d46e6fa 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Craft plugin to generate an embed URL from a YouTube or Vimeo URL. -Ported over from [Viget's](https://viget.com) Craft 2.x [Video Embed plugin](https://github.com/vigetlabs/craft-videoembed). +Ported over from [Viget's](https://viget.com) [Video Embed plugin for Craft 2.x](https://github.com/vigetlabs/craft-videoembed). ## Requirements @@ -10,21 +10,16 @@ This plugin requires Craft CMS 3.0.0-beta.23 or later. ## Installation -To install the plugin, follow these instructions. +To install Video Embedder, follow these steps: -1. Open your terminal and go to your Craft project: +1. Install with Composer via `composer require mikestecker/craft3-videoembedder` from your project directory +2. Install plugin in the Craft Control Panel under Settings > Plugins - cd /path/to/project - -2. Then tell Composer to load the plugin: - - composer require mikestecker/video-embedder - -3. In the Control Panel, go to Settings → Plugins and click the “Install” button for Video Embedder. +Video Embedder works on Craft 3.x. ## Video Embedder Overview --Insert text here- +Video Embedder will take your YouTube or Vimeo URL's and convert the URL into an embed-friendly URL for use inside an iframe tag. Video Embedder also has a variable which will take the same URL and get the thumbnail image URL. ## Using Video Embedder @@ -66,5 +61,6 @@ 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 Brought to you by [Mike Stecker](http://github.com/mikestecker)