first commit

2018-04-11 17:57:57 +02:00
commit fdfcfbd2a6
4073 changed files with 501866 additions and 0 deletions
@@ -0,0 +1,47 @@
+# [Installation and update guide][project]
+[project]: https://github.com/sommerregen/grav-plugin-mediaembed
+
+## Installation
+
+Installing the `MediaEmbed` plugin can be done in one of two ways. The GPM (Grav Package Manager) installation method enables you to quickly and easily install the plugin with a simple terminal command, while the manual method enables you to do so via a zip file.
+
+### GPM Installation (Preferred)
+
+The simplest way to install this plugin is via the [Grav Package Manager (GPM)](http://learn.getgrav.org/advanced/grav-gpm) through your system's Terminal (also called the command line). From the root of your Grav install type:
+
+	bin/gpm install mediaembed
+
+This will install the `MediaEmbed` plugin into your `/user/plugins` directory within Grav. Its files can be found under `/your/site/grav/user/plugins/mediaembed`.
+
+### Manual Installation
+
+To install this plugin, just download the zip version of this repository and unzip it under `/your/site/grav/user/plugins`. Then, rename the folder to `mediaembed`. You can find these files either on [GitHub](https://github.com/sommerregen/grav-plugin-mediaembed) or via [GetGrav.org](http://getgrav.org/downloads/plugins).
+
+You should now have all the plugin files under
+
+	/your/site/grav/user/plugins/mediaembed
+
+>> NOTE: This plugin is a modular component for Grav which requires [Grav](http://github.com/getgrav/grav) and a theme to be installed in order to operate.
+
+## Updating
+
+As development for `MediaEmbed` continues, new versions may become available that add additional features and functionality, improve compatibility with newer Grav releases, and generally provide a better user experience. Updating `MediaEmbed` is easy, and can be done through Grav's GPM system, as well as manually.
+
+### GPM Update (Preferred)
+
+The simplest way to update this plugin is via the [Grav Package Manager (GPM)](http://learn.getgrav.org/advanced/grav-gpm). You can do this with this by navigating to the root directory of your Grav install using your system's Terminal (also called command line) and typing the following:
+
+	bin/gpm update mediaembed
+
+This command will check your Grav install to see if your `MediaEmbed` plugin is due for an update. If a newer release is found, you will be asked whether or not you wish to update. To continue, type `y` and hit enter. The plugin will automatically update and clear Grav's cache.
+
+#### Manual Update
+
+Manually updating `MediaEmbed` is pretty simple. Here is what you will need to do to get this done:
+
+* Delete the `your/site/user/plugins/mediaembed` directory.
+* Download the new version of the `MediaEmbed` plugin from either [GitHub](https://github.com/sommerregen/grav-plugin-mediaembed) or [GetGrav.org](http://getgrav.org/downloads/plugins).
+* Unzip the zip file in `your/site/user/plugins` and rename the resulting folder to `mediaembed`.
+* Clear the Grav cache. The simplest way to do this is by going to the root Grav directory in terminal and typing `bin/grav clear-cache`.
+
+>> Note: Any changes you have made to any of the files listed under this directory will also be removed and replaced by the new set. Any files located elsewhere (for example a YAML settings file placed in `user/config/plugins`) will remain intact.