From 0a4233614d71d0df944822ef3d4395c9729e00e8 Mon Sep 17 00:00:00 2001 From: Hailee Kenney Date: Tue, 15 Mar 2016 23:23:05 -0700 Subject: [PATCH] (PDOC-74) Update README to reflect gem release Since 0.4.0 will be the last version of strings released as a puppet module, update the README to reflect the fact that this method of distribution is deprecated and add a description of how to install the Ruby gem version of strings. --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 9fe98a7..b4b081a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,6 @@ +**PLEASE NOTE that the puppetlabs-strings module is being deprecated in favor of a gem. 0.4.0 will be the last release of +the puppet module and the first release of the Ruby gem. Please see the installation instructions below.** + Puppet Strings ============= [![Build Status](https://travis-ci.org/puppetlabs/puppetlabs-strings.png?branch=master)](https://travis-ci.org/puppetlabs/puppetlabs-strings) @@ -52,6 +55,22 @@ $ puppet resource package yard provider=gem Installing Strings Itself ------------------------- +Strings can be installed using the [puppet-strings Ruby gem](https://rubygems.org/gems/puppet-strings). To ensure it +is installed in right place, it is best to install it using Puppet. + +For Puppet 4.x: +``` +$ puppet resource package puppet-strings provider=puppet_gem +``` + +For Puppet 3.x: +``` +$ puppet resource package puppet-strings provider=gem +``` + +Versions of less than or equal to 0.4.0 may be installed as a puppet module, but **this method of distribution is +deprecated and the module hosted on the Puppet Forge will no longer be updated after the 0.4.0 release.** The methods +for installing the module are: Strings can be installed from the [Puppet Forge][forge strings] or from source.