Merge pull request #782 from puppetlabs/pdksync_1.7.0-0-g57412ed

[puppet-modules/puppetlabs-apt.git] / README.md

diff --git a/README.md b/README.md
index 9ece72bd1d83d63fcd2e93bda343ed87d9e745d1..9af6b9af8b32935fe99c436a46ef152b2fcf7b59 100644 (file)
--- a/README.md
+++ b/README.md
@@ -228,18 +228,18 @@ apt::source { "archive.ubuntu.com-${lsbdistcodename}-backports":
 
 ### Manage login configuration settings for an APT source or proxy in `/etc/apt/auth.conf`
 
-Starting with APT version 1.5 you can define login configuration settings (like
-username and password) for APT sources or proxies that require authentication
-in the file `/etc/apt/auth.conf`. This is preferable to embedding login
-information directly in `source.list` entries which are usually world-readable.
+Starting with APT version 1.5, you can define login configuration settings, such as
+username and password, for APT sources or proxies that require authentication
+in the `/etc/apt/auth.conf` file. This is preferable to embedding login
+information directly in `source.list` entries, which are usually world-readable.
 
-The file `/etc/apt/auth.conf` follows the format of netrc (as used by ftp or
+The `/etc/apt/auth.conf` file follows the format of netrc (used by ftp or
 curl) and has restrictive file permissions. See
 https://manpages.debian.org/testing/apt/apt_auth.conf.5.en.html for details.
 
 Use the optional `apt::auth_conf_entries` parameter to specify an array of
 hashes containing login configuration settings. These hashes may only contain
-the keys `machine`, `login` and `password`.
+the `machine`, `login` and `password` keys.
 
 ```puppet
 class { 'apt':
@@ -556,10 +556,10 @@ All parameters are optional.
 
 ## Limitations
 
-This module is tested and officially supported on Debian 6 and 7 and Ubuntu 10.04, 12.04, and 14.04. Testing on other platforms has been light and cannot be guaranteed.
-
 This module is not designed to be split across [run stages](https://docs.puppetlabs.com/puppet/latest/reference/lang_run_stages.html).
 
+For an extensive list of supported operating systems, see [metadata.json](https://github.com/puppetlabs/puppetlabs-apt/blob/master/metadata.json)
+
 ### Adding new sources or PPAs
 
 If you are adding a new source or PPA and trying to install packages from the new source or PPA on the same Puppet run, your `package` resource should depend on `Class['apt::update']`, in addition to depending on the `Apt::Source` or the `Apt::Ppa`. You can also add [collectors](https://docs.puppetlabs.com/puppet/latest/reference/lang_collectors.html) to ensure that all packages happen after `apt::update`, but this can lead to dependency cycles and has implications for [virtual resources](https://docs.puppetlabs.com/puppet/latest/reference/lang_collectors.html#behavior).