README.md in foreman_templates-1.2.0 vs README.md in foreman_templates-1.3.0

- old
+ new

@@ -1,38 +1,35 @@ # foreman\_templates This plugin will sync the contents of the Foreman Community Templates -[repository](https://github.com/theforeman/community-templates/) to your local -Foreman instance +[repository](https://github.com/theforeman/community-templates/) (or a git repo +of your choice) to your local Foreman instance -# Installation +## Installation -Require the gem in Foreman, `bundler.d/Gemfile.local.rb`: +See [How_to_Install_a_Plugin](http://projects.theforeman.org/projects/foreman/wiki/How_to_Install_a_Plugin) +for how to install Foreman plugins -```yaml -gem 'foreman_templates' -``` +The gem name is "foreman_templates". -Or, for the very latest code: +RPM users can install the "ruby193-rubygem-foreman_templates" or "rubygem-foreman_templates" packages. -```yaml -gem 'foreman_templates', :git => "https://github.com/GregSutcliffe/foreman_templates.git" -``` +## Latest code -Update Foreman with the new gems: +You can get the develop branch of the plugin by specifying your Gemfile in this way: - bundle update + gem 'foreman_templates', :git => "https://github.com/theforeman/foreman_templates.git" -# Configuration +## Configuration There is UI no configuration at this time. -# Usage +## Usage The plugin provides a Rake task to import the templates. To use it, simply do - bundle exec rake templates:sync + foreman-rake templates:sync This will create a set of templates named "Community ...." (or update them if they already exist). Audit history is preserved, but no comment is currently added for any changes made. @@ -47,34 +44,34 @@ * branch => Branch in Git repo [default branch] * prefix => The string all imported templates should begin with [Community] * dirname => The directory within the git tree containing the templates [/] * filter => Import names matching this regex (case-insensitive; snippets are not filtered) -# Examples +## Examples Just import all the templates in from the default repo - rake templates:sync + foreman-rake templates:sync Import all templates from a custom repo, with a different prefix - rake templates:sync repo="http://github.com/GregSutcliffe/community-templates" prefix="Greg" + foreman-rake templates:sync repo="http://github.com/GregSutcliffe/community-templates" prefix="Greg" Import templates matching the name "Fedora" - rake templates:sync filter='fedora' + foreman-rake templates:sync filter='fedora' Import templates from a subsection of a git repo: - rake templates:sync repo="http://github.com/GregSutcliffe/community-templates" dirname='/subdir' + foreman-rake templates:sync repo="http://github.com/GregSutcliffe/community-templates" dirname='/subdir' -# TODO +## TODO * Allow user to filter to a specific subset of templates * Add associations by template family * Add a button to the UI with Deface to run the rake task -# Copyright +## Copyright Copyright (c) 2013 Greg Sutcliffe This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by