diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..f589123 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,5 @@ +# v1.0.0 +## 01/23/2016 + +1. [](#new) + * ChangeLog started... \ No newline at end of file diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..d9f54e7 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2014 Grav + +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. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..14324d8 --- /dev/null +++ b/README.md @@ -0,0 +1,97 @@ +# Grav Plugin - View + +`View` is a [Grav](http://github.com/getgrav/grav) plugin that allows you find a page and send the collection to a template. + +## Features + +* Override parameters from referencing page. +* Assign any template to any view. +* Add views to modular pages, allowing you to manage, order, etc. + +# Installation + +Installing the View plugin can be done in one of two ways. Our 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 view + +This will install the View plugin into your `/user/plugins` directory within Grav. Its files can be found under `/your/site/grav/user/plugins/view`. + +## 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 `view`. You can find these files on [GitHub](https://github.com/ellioseven/grav-plugin-view). + +You should now have all the plugin files under + + /your/site/grav/user/plugins/view + +> NOTE: This plugin is a modular component for Grav which requires [Grav](http://github.com/getgrav/grav), the [Error](https://github.com/getgrav/grav-plugin-error) and [Problems](https://github.com/getgrav/grav-plugin-problems) plugins, and a theme to be installed in order to operate. + +# Usage + +1. Add modular to modular page +2. Select 'View' as Modular Template +3. Specify a page. Optionally, you can specify a template, pagination, and parameters. +4. If you specify a template, you will need to create it in your theme, +`/your/site/grav/user/themes/templates/