From 391a3d68da2e28f4ae5fff06eab994a3eec37239 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rapha=C3=ABl=20Pinson?= Date: Wed, 13 Mar 2013 10:13:35 +0100 Subject: Use markdown in README --- README.markdown | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) (limited to 'README.markdown') diff --git a/README.markdown b/README.markdown index 460e4c0..9961912 100644 --- a/README.markdown +++ b/README.markdown @@ -1,27 +1,28 @@ -= Augeas Puppet module = +# Augeas Puppet module -== Usage == +## Usage include augeas -== Description == +## Description This module does 3 things: - o lets you force the augeas version by defining $augeas_version, otherwise puppet will +* lets you force the augeas version by defining $augeas_version, otherwise puppet will only ensure the packages are present. - o lets you force the ruby library version by defining $augeas_ruby_version, otherwise puppet will +* lets you force the ruby library version by defining $augeas_ruby_version, otherwise puppet will only ensure the libagueas-ruby version will be installed according to internal critera - o lets you deploy an augeas lens and any associated test files, running unit tests and not installing if they fail: +* lets you deploy an augeas lens and any associated test files, running unit tests and not installing if they fail: - Parameters: - - *ensure*: present/absent - - *lens_source*: the source for the lens - - *test_source*: optionally, the source for the test file. - - *stock_since*: optionally, indicate in which version of Augeas - the lens became stock, so it will not be deployed above that version. +Parameters: - Example usage: +- *ensure*: present/absent +- *lens_source*: the source for the lens +- *test_source*: optionally, the source for the test file. +- *stock_since*: optionally, indicate in which version of Augeas + the lens became stock, so it will not be deployed above that version. + +Example usage: augeas::lens { 'networkmanager': lens_source => 'puppet:///modules/networkmanager/lenses/networkmanager.aug', -- cgit v1.2.3