📦 Initial commit of new "MediaEmbed" plugin

CHANGELOG.md

@@ -0,0 +1,5 @@
+# v1.0.0
+## 04/26/2015
+
+1. [](#new)
+    * ChangeLog started...

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Benjamin Regler
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,114 @@
+# [Grav MediaEmbed Plugin][project]
+
+> This plugin embeds several media sites (e.g. YouTube, Vimeo, Soundcloud) by only providing the URL to the medium.
+
+## About
+
+Grav MediaEmbed plugin is the official successor of [Grav VideoEmbed plugin](https://github.com/sommerregen/grav-plugin-mediaembed/), allows to embed several media sites by only providing the URL to the medium and supports lazy loading techniques for videos and other media. Currently it supports
+
+- YouTube
+- Vimeo
+- DailyMotion
+- SoundCloud
+- Spotify
+- Flickr
+- Imgur
+- Instagram
+- GitHub
+
+but more services are coming soon! In principle it supports any service, which provides the [oEmbed format](http://www.oembed.com/). Media are embedded using the Markdown syntax for images (`![Alt](URL "Title")`), e.g. the below screenshot was created with the following code:
+
+```
+![](https://www.flickr.com/photos/chris_gin/6585842063)
+```
+
+![Screenshot MediaEmbed Plugin](assets/screenshot.png "MediaEmbed Preview")
+
+## Installation and Updates
+
+Installing or updating the `MediaEmbed` plugin can be done in one of two ways. Using the GPM (Grav Package Manager) installation method (i.e. `bin/gpm install mediaembed`) or manual install or update method by downloading [this plugin](https://github.com/sommerregen/grav-plugin-mediaembed) and extracting all plugin files to
+
+	/your/site/grav/user/plugins/mediaembed
+
+For more informations, please check the [Installation and update guide](docs/INSTALL.md).
+
+## Usage
+
+The `MediaEmbed` plugin comes with some sensible default configuration, that are pretty self explanatory:
+
+### Config Defaults
+
+```
+# Global plugin configurations
+
+enabled: true                # Set to false to disable this plugin completely
+built_in_css: true           # Use built-in CSS of the plugin
+built_in_js: true            # Use built-in JS of the plugin
+
+# Default options for MediaEmbed configuration.
+
+# -- Media --
+media:
+  width: 640                 # Default media width
+  height: 390                # Default media height including controls
+  adjust: true               # Adjust media or keep default dimensions?
+
+  preview: true              # Show or hide media preview
+  responsive: false          # Allow media to be responsive
+  protocol: "http://"        # Default protocol for remote media resources
+
+services:
+	<ServiceName>:
+    enabled: true            # Set to false to disable this service completely
+    type: <Type>             # Type of the media service
+
+    # URL of media service used for embedding
+    url: "www.domain.com/embed/{:id}"
+
+    # Canonical URL of media service (used in endpoint calls)
+    canonical: "http://www.domain.com/{:id}"
+
+    # Endpoint to grab media informations
+    endpoint: "http://www.domain.com/oembed?url={:canonical}&format=json"
+
+    # Regex filters ("~REGEX~i") to grab media id
+    schemes:
+      - "domain.com/*"
+
+    # Custom service-related media option overrides
+    params:
+      <Param>: <Value>
+```
+
+If you need to change any value, then the best process is to copy the [mediaembed.yaml](mediaembed.yaml) file into your `users/config/plugins/` folder (create it if it doesn't exist), and then modify there. This will override the default settings.
+
+## Contributing
+
+You can contribute at any time! Before opening any issue, please search for existing issues and review the [guidelines for contributing](docs/CONTRIBUTING.md).
+
+After that please note:
+
+* If you find a bug or would like to make a feature request or suggest an improvement, [please open a new issue][issues]. If you have any interesting ideas for additions to the syntax please do suggest them as well!
+* Feature requests are more likely to get attention if you include a clearly described use case.
+* If you wish to submit a pull request, please make again sure that your request match the [guidelines for contributing](docs/CONTRIBUTING.md) and that you keep track of adding unit tests for any new or changed functionality.
+
+### Support and donations
+
+If you like my project, feel free to support me via [![Flattr](https://api.flattr.com/button/flattr-badge-large.png)][flattr] or by sending me some bitcoins to **1HQdy5aBzNKNvqspiLvcmzigCq7doGfLM4**.
+
+Thanks!
+
+## License
+
+Copyright (c) 2015 [Benjamin Regler][github]. See also the list of [contributors] who participated in this project.
+
+[Licensed](LICENSE) for use under the terms of the [MIT license][mit-license].
+
+[github]: https://github.com/sommerregen/ "GitHub account from Benjamin Regler"
+[mit-license]: http://www.opensource.org/licenses/mit-license.php "MIT license"
+
+[flattr]: https://flattr.com/submit/auto?user_id=Sommerregen&url=https://github.com/sommerregen/grav-plugin-mediaembed "Flatter my GitHub project"
+
+[project]: https://github.com/sommerregen/grav-plugin-mediaembed
+[issues]: https://github.com/sommerregen/grav-plugin-mediaembed/issues "GitHub Issues for Grav MediaEmbed Plugin"
+[contributors]: https://github.com/sommerregen/grav-plugin-mediaembed/graphs/contributors "List of contributors of the project"