kienan
/
puppet-strings
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

(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.
This commit is contained in:
Hailee Kenney 2016-03-15 23:23:05 -07:00
parent 678ba735e8
commit 0a4233614d
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -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.