From 97e1d236df19c5becd836a12c2da4c06401659c6 Mon Sep 17 00:00:00 2001 From: Jon Uhlmann Date: Wed, 19 Jun 2019 23:28:57 +0200 Subject: [PATCH] :memo: Add readme --- README.md | 76 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 76 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..3ed7260 --- /dev/null +++ b/README.md @@ -0,0 +1,76 @@ +[![Latest Stable Version](https://poser.pugx.org/jonnitto/prettyembedvideo/v/stable)](https://packagist.org/packages/jonnitto/prettyembedvideo) +[![Total Downloads](https://poser.pugx.org/jonnitto/prettyembedvideo/downloads)](https://packagist.org/packages/jonnitto/prettyembedvideo) +[![License](https://poser.pugx.org/jonnitto/prettyembedvideo/license)](https://packagist.org/packages/jonnitto/prettyembedvideo) +[![GitHub forks](https://img.shields.io/github/forks/jonnitto/Jonnitto.PrettyEmbedVideo.svg?style=social&label=Fork)](https://github.com/jonnitto/Jonnitto.PrettyEmbedVideo/fork) +[![Support development](https://img.shields.io/badge/Donate-PayPal-yellow.svg)](https://www.paypal.me/Jonnitto/20eur) +[![My wishlist on amazon](https://img.shields.io/badge/Wishlist-Amazon-yellow.svg)](https://www.amazon.de/hz/wishlist/ls/2WPGORAVYF39B?&sort=default) +[![GitHub stars](https://img.shields.io/github/stars/jonnitto/Jonnitto.PrettyEmbedVideo.svg?style=social&label=Stars)](https://github.com/jonnitto/Jonnitto.PrettyEmbedVideo/stargazers) +[![GitHub watchers](https://img.shields.io/github/watchers/jonnitto/Jonnitto.PrettyEmbedVideo.svg?style=social&label=Watch)](https://github.com/jonnitto/Jonnitto.PrettyEmbedVideo/subscription) +[![GitHub followers](https://img.shields.io/github/followers/jonnitto.svg?style=social&label=Follow)](https://github.com/jonnitto/followers) +[![Follow Jon on Twitter](https://img.shields.io/twitter/follow/jonnitto.svg?style=social&label=Follow)](https://twitter.com/jonnitto) + +# Jonnitto.PrettyEmbedVideo + +Prettier embeds for your native videos in [Neos CMS](https://www.neos.io) - with nice options like high-res preview images, lightbox feature, captions, and advanced customization of embed options. + +| Version | Neos | +| ------- | ------- | +| 1.\* | ^4.2.\* | + +## Installation + +Most of the time you have to make small adjustments to a package (e.g. configuration in `Settings.yaml`). Because of that, it is important to add the corresponding package to the composer from your theme package. Mostly this is the site packages located under `Packages/Sites/`. To install it correctly go to your theme package (e.g.`Packages/Sites/Foo.Bar`) and run following command: + +```bash +composer require jonnitto/prettyembedvideo --no-update +``` + +The `--no-update` command prevent the automatic update of the dependencies. After the package was added to your theme `composer.json`, go back to the root of the Neos installation and run `composer update`. Et voilà! Your desired package is now installed correctly. + +## PrettyEmbedCollection + +This package is member of the [PrettyEmbedCollection](https://github.com/jonnitto/Jonnitto.PrettyembedCollection) which contains following packages: + +- [PrettyEmbedVideo](https://github.com/jonnitto/Jonnitto.PrettyEmbedVideo) +- [PrettyEmbedVimeo](https://github.com/jonnitto/Jonnitto.PrettyEmbedVimeo) +- [PrettyEmbedYoutube](https://github.com/jonnitto/Jonnitto.PrettyEmbedYoutube) + +If you install the PrettyEmbedCollection the video players get grouped into a own group in the node inspector, otherwise they will be in the default group. + +## FAQ + +**What are the differences from the PrettyEmbed series to [Jonnitto.Plyr](https://github.com/jonnitto/Jonnitto.Plyr)?** + +| | PrettyEmbed series | Plyr | +| ---------------------------------- | :----------------: | :----: | +| YouTube Video | ✓ | ✓ | +| YouTube Playlist | ✓ | | +| Vimeo | ✓ | ✓ | +| Native Audio | | ✓ | +| Native Video | ✓ | ✓ | +| Advanced captions for native video | ✓ | | +| Preview image | ✓ | | +| Lightbox included | ✓ | | +| Preview image | ✓ | | +| Javascript API | | ✓ | +| Filesize (JS & CSS) | smaller | bigger | + +All packages from the PrettyEmbed series have the benefit of a better frontend performance since the player gets only loaded on request. So, no iframe/video get's loaded until the user wants to watch a video. + +## Customization + +### Configuration + +If you want to customize the default settings, take a look at the [Settings.Jonnitto.yaml](Configuration/Settings.Jonnitto.yaml) file. If no node property is giving, these default values will be taken. If you, for example, don't want to let the editor choose if the video should open in a lightbox you can deactivate the mixin in your Configuration folder like this: + +```yaml +"Jonnitto.PrettyEmbedVideo:Content.Video": + superTypes: + "Jonnitto.PrettyEmbedHelper:Mixin.Lightbox": false +``` + +### Fusion + +If you want to use the player as a pure component, you can use the [`Jonnitto.PrettyEmbedVimeo:Component.Video`](Resources/Private/Fusion/Component/Video.fusion) fusion prototype. + +If you want to read the node properties and let the package handle all for you, you should use the [`Jonnitto.PrettyEmbedVideo:Content.Video`](Resources/Private/Fusion/Content/Video.fusion) prototype. For easier including in your own node types, you can disable the content element wrapping with `contentElement = false`. This is useful if you want to create for example a text with video node type.