X-Git-Url: https://review.fuel-infra.org/gitweb?a=blobdiff_plain;f=README.md;h=6badc1a43fe7bb9e3f26caa943b1f21fc77dd407;hb=df8f80aedbb044a6d7783512d0e3c98160c6b238;hp=99e808b8cc3b4e095dd79959996ef459e87bb71a;hpb=36b7b8abff7e21d6810b60d55e6225fb2371e5da;p=puppet-modules%2Fpuppetlabs-apt.git

diff --git a/README.md b/README.md
index 99e808b..6badc1a 100644
--- a/README.md
+++ b/README.md
@@ -33,7 +33,7 @@ To begin using the APT module with default parameters, declare the class
 
     include apt
 
-Puppet code that uses anything from the APT module requires that the core apt class be declared/\s\+$//e
+Puppet code that uses anything from the APT module requires that the core apt class be declared.
 
 Usage
 -----
@@ -54,7 +54,8 @@ The parameters for `apt` are not required in general and are predominantly for d
       purge_sources_list   => false,
       purge_sources_list_d => false,
       purge_preferences_d  => false,
-      update_timeout       => undef
+      update_timeout       => undef,
+      fancy_progress       => undef
     }
 
 Puppet will manage your system's `sources.list` file and `sources.list.d` directory but will do its best to respect existing content.
@@ -84,7 +85,7 @@ this module.
 
     apt_key { 'puppetlabs':
       ensure => 'present',
-      id     => '4BD6EC30',
+      id     => '1054B7A24BD6EC30',
     }
 
 You can additionally set the following attributes:
@@ -104,12 +105,12 @@ uses the aforementioned `apt_key` native type. As such it no longer requires
 the wget command that the old implementation depended on.
 
     apt::key { 'puppetlabs':
-      key        => '4BD6EC30',
+      key        => '1054B7A24BD6EC30',
       key_server => 'pgp.mit.edu',
     }
 
     apt::key { 'jenkins':
-      key        => 'D50582E6',
+      key        => '9B7D32F2D50582E6',
       key_source => 'http://pkg.jenkins-ci.org/debian/jenkins-ci.org.key',
     }
 
@@ -193,14 +194,16 @@ Sets the default apt release. This class is particularly useful when using repos
 Adds an apt source to `/etc/apt/sources.list.d/`.
 
     apt::source { 'debian_unstable':
+      comment           => 'This is the iWeb Debian unstable mirror',
       location          => 'http://debian.mirror.iweb.ca/debian/',
       release           => 'unstable',
       repos             => 'main contrib non-free',
       required_packages => 'debian-keyring debian-archive-keyring',
-      key               => '46925553',
+      key               => '8B48AD6246925553',
       key_server        => 'subkeys.pgp.net',
       pin               => '-10',
-      include_src       => true
+      include_src       => true,
+      include_deb       => true
     }
 
 If you would like to configure your system so the source is the Puppet Labs APT repository
@@ -208,10 +211,17 @@ If you would like to configure your system so the source is the Puppet Labs APT
     apt::source { 'puppetlabs':
       location   => 'http://apt.puppetlabs.com',
       repos      => 'main',
-      key        => '4BD6EC30',
+      key        => '1054B7A24BD6EC30',
       key_server => 'pgp.mit.edu',
     }
 
+### Facts
+
+There are a few facts included within the apt module describing the state of the apt system:
+
+* `apt_updates` - the number of updates available on the system
+* `apt_security_updates` - the number of updates which are security updates
+* `apt_package_updates` - the package names that are available for update. On Facter 2.0 and newer this will be a list type, in earlier versions it is a comma delimitered string.
 
 #### Hiera example
 <pre>
@@ -221,15 +231,16 @@ apt::sources:
       release: 'unstable'
       repos: 'main contrib non-free'
       required_packages: 'debian-keyring debian-archive-keyring'
-      key: '55BE302B'
+      key: '9AA38DCD55BE302B'
       key_server: 'subkeys.pgp.net'
       pin: '-10'
       include_src: 'true'
+      include_deb: 'true'
 
   'puppetlabs':
       location: 'http://apt.puppetlabs.com'
       repos: 'main'
-      key: '4BD6EC30'
+      key: '1054B7A24BD6EC30'
       key_server: 'pgp.mit.edu'
 </pre>
 
@@ -244,7 +255,7 @@ This test will set up a Puppet Labs apt repository. Start by creating a new smok
     apt::source { 'puppetlabs':
       location   => 'http://apt.puppetlabs.com',
       repos      => 'main',
-      key        => '4BD6EC30',
+      key        => '1054B7A24BD6EC30',
       key_server => 'pgp.mit.edu',
     }
 
@@ -320,3 +331,4 @@ A lot of great people have contributed to this module. A somewhat current list f
 * William Van Hevelingen <blkperl@cat.pdx.edu> <wvan13@gmail.com>
 * Zach Leslie <zach@puppetlabs.com>
 * Daniele Sluijters <github@daenney.net>
+* Daniel Paulus <daniel@inuits.eu>